@alicloud/ccc20200701 2.38.2 → 2.38.3

package/src/models/GetInstanceRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetInstanceRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetInstanceResponseBody.ts

@@ -3,48 +3,82 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetInstanceResponseBodyDataAdminList extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the administrator.
+   * 
+   * @example
+   * 管理员
+   */
   displayName?: string;
   /**
+   * @remarks
+   * The mailbox.
+   * 
    * @example
    * username@example.com
    */
   email?: string;
   /**
+   * @remarks
+   * The agent\\"s extension number.
+   * 
    * @example
    * 8032****
    */
   extension?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The agent\\"s logon name.
+   * 
    * @example
    * agent
    */
   loginName?: string;
   /**
+   * @remarks
+   * The agent\\"s personal phone number.
+   * 
    * @example
    * 1382114****
    */
   mobile?: string;
   /**
+   * @remarks
+   * The role ID. The format is: Role\\@Instance ID.
+   * 
    * @example
    * Admin@ccc-test
    */
   roleId?: string;
   /**
+   * @remarks
+   * The role name.
+   * 
    * @example
    * Admin
    */
   roleName?: string;
   /**
+   * @remarks
+   * The agent ID.
+   * 
    * @example
    * agent@ccc-test
    */
   userId?: string;
   /**
+   * @remarks
+   * The work mode.
+   * 
    * @example
    * ON_SITE
    */
@@ -115,29 +149,58 @@ export class GetInstanceResponseBodyDataChatbotBusinessUnit extends $dara.Model
 }
 
 export class GetInstanceResponseBodyDataNumberListSkillGroups extends $dara.Model {
+  /**
+   * @remarks
+   * The description of the skill group.
+   * 
+   * @example
+   * 云联络中心的测试技能组。
+   */
   description?: string;
+  /**
+   * @remarks
+   * The display name of the skill group.
+   * 
+   * @example
+   * 测试技能组
+   */
   displayName?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The name of the skill group.
+   * 
    * @example
    * skillgroup
    */
   name?: string;
   /**
+   * @remarks
+   * The number of phone numbers associated with the skill group.
+   * 
    * @example
    * 1
    */
   phoneNumberCount?: number;
   /**
+   * @remarks
+   * The skill group ID.
+   * 
    * @example
    * skillgroup@ccc-test
    */
   skillGroupId?: string;
   /**
+   * @remarks
+   * The number of agents associated with the skill group.
+   * 
    * @example
    * 3
    */
@@ -177,34 +240,70 @@ export class GetInstanceResponseBodyDataNumberListSkillGroups extends $dara.Mode
 
 export class GetInstanceResponseBodyDataNumberList extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the number is active.
+   * 
    * @example
    * true
    */
   active?: boolean;
+  /**
+   * @remarks
+   * The city where the number is registered.
+   * 
+   * @example
+   * 乐山
+   */
   city?: string;
   /**
+   * @remarks
+   * The ID of the contact flow (IVR) associated with the phone number.
+   * 
    * @example
    * 2ec7a58f-3243-4815-bb21-97b480b95f5e
    */
   contactFlowId?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The phone number.
+   * 
    * @example
    * 0830011****
    */
   number?: string;
+  /**
+   * @remarks
+   * The province where the number is registered.
+   * 
+   * @example
+   * 四川
+   */
   province?: string;
+  /**
+   * @remarks
+   * The list of skill groups associated with the number.
+   */
   skillGroups?: GetInstanceResponseBodyDataNumberListSkillGroups[];
   /**
+   * @remarks
+   * The purpose of the number.
+   * 
    * @example
    * Bidirection
    */
   usage?: string;
   /**
+   * @remarks
+   * The agent ID. If this parameter is not empty, the number is a personal outbound number for the agent.
+   * 
    * @example
    * agent@ccc-test
    */
@@ -250,33 +349,70 @@ export class GetInstanceResponseBodyDataNumberList extends $dara.Model {
 }
 
 export class GetInstanceResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of administrators.
+   */
   adminList?: GetInstanceResponseBodyDataAdminList[];
   agentType?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the instance belongs.
+   * 
    * @example
    * 157123456789****
    */
   aliyunUid?: string;
   chatbotBusinessUnit?: GetInstanceResponseBodyDataChatbotBusinessUnit;
   /**
+   * @remarks
+   * The URL of the Cloud Contact Center instance homepage. This URL is formed by combining the base URL of Cloud Contact Center and the instance ID.
+   * 
    * @example
    * https://ccc-v2.aliyun.com/#/workbench/ccc-test
    */
   consoleUrl?: string;
+  /**
+   * @remarks
+   * The description of the instance.
+   * 
+   * @example
+   * 云联络中心的测试实例。
+   */
   description?: string;
   /**
+   * @remarks
+   * The domain name of the instance. It is globally unique.
+   * 
    * @example
    * ccc-test
    */
   domainName?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * ccc-test
    */
   id?: string;
+  /**
+   * @remarks
+   * The instance name.
+   * 
+   * @example
+   * 测试实例
+   */
   name?: string;
+  /**
+   * @remarks
+   * The list of numbers.
+   */
   numberList?: GetInstanceResponseBodyDataNumberList[];
   /**
+   * @remarks
+   * The instance status.
+   * 
    * @example
    * RUNNING
    */
@@ -333,18 +469,38 @@ export class GetInstanceResponseBodyData extends $dara.Model {
 
 export class GetInstanceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The data.
+   */
   data?: GetInstanceResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 2778FA12-EDD6-42AA-9B15-AF855072E5E5
    */

package/src/models/GetInstanceTrendingReportRequest.ts

@@ -4,20 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetInstanceTrendingReportRequest extends $dara.Model {
   /**
+   * @remarks
+   * End UNIX timestamp. The default value is the current time. The format is a Unix timestamp in milliseconds.
+   * 
    * @example
    * 1604725528000
    */
   endTime?: number;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * ccc-test
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * Media type. The default value is Audio. Other valid values include Chat and Video.
+   * 
+   * @example
+   * Audio
+   */
   mediaType?: string;
   /**
+   * @remarks
+   * Start UNIX timestamp. The default value is the start time of the current day. The earliest allowed time is 180 days before the current time. The interval between the start time and end time cannot exceed 7 days. The format is a Unix timestamp in milliseconds.
+   * 
    * @example
    * 1604639129000
    */

package/src/models/GetInstanceTrendingReportResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetInstanceTrendingReportResponseBodyDataInbound extends $dara.Model {
   /**
+   * @remarks
+   * Number of calls abandoned in the IVR, meaning calls that were abandoned during the IVR flow after entering it.
+   * 
    * @example
    * 0
    */
   callsAbandonedInIVR?: number;
   /**
+   * @remarks
+   * Number of calls abandoned in the queue, meaning calls that were abandoned while waiting in the skill group queue after entering it.
+   * 
    * @example
    * 0
    */
   callsAbandonedInQueue?: number;
   /**
+   * @remarks
+   * Number of calls abandoned during ringing.
+   * 
    * @example
    * 0
    */
   callsAbandonedInRing?: number;
   /**
+   * @remarks
+   * Number of calls answered by agents. If a single call is distributed to multiple agents, it is counted as one call.
+   * 
    * @example
    * 0
    */
   callsHandled?: number;
   /**
+   * @remarks
+   * Number of calls that entered the queue. If a single call enters the queue multiple times, it is counted as one call.
+   * 
    * @example
    * 0
    */
   callsQueued?: number;
   /**
+   * @remarks
+   * The start time of the segment statistics, in UNIX timestamp format, in milliseconds.
+   * 
    * @example
    * 1604639129000
    */
   statsTime?: number;
   /**
+   * @remarks
+   * Total number of incoming calls.
+   * 
    * @example
    * 0
    */
@@ -73,16 +94,25 @@ export class GetInstanceTrendingReportResponseBodyDataInbound extends $dara.Mode
 
 export class GetInstanceTrendingReportResponseBodyDataOutbound extends $dara.Model {
   /**
+   * @remarks
+   * Number of answered outbound calls.
+   * 
    * @example
    * 0
    */
   callsAnswered?: number;
   /**
+   * @remarks
+   * Start time of the segment, in UNIX timestamp format, in milliseconds.
+   * 
    * @example
    * 1604639129000
    */
   statsTime?: number;
   /**
+   * @remarks
+   * Total number of outbound calls.
+   * 
    * @example
    * 0
    */
@@ -113,7 +143,21 @@ export class GetInstanceTrendingReportResponseBodyDataOutbound extends $dara.Mod
 }
 
 export class GetInstanceTrendingReportResponseBodyDataOverall extends $dara.Model {
+  /**
+   * @remarks
+   * Maximum number of agents logged on simultaneously during this time range.
+   * 
+   * @example
+   * 102
+   */
   maxLoggedInAgents?: number;
+  /**
+   * @remarks
+   * The start time of the segment statistics, in UNIX timestamp format, in milliseconds.
+   * 
+   * @example
+   * 1604639129000
+   */
   statsTime?: number;
   static names(): { [key: string]: string } {
     return {
@@ -139,8 +183,20 @@ export class GetInstanceTrendingReportResponseBodyDataOverall extends $dara.Mode
 }
 
 export class GetInstanceTrendingReportResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Inbound metrics.
+   */
   inbound?: GetInstanceTrendingReportResponseBodyDataInbound[];
+  /**
+   * @remarks
+   * Outbound metrics.
+   */
   outbound?: GetInstanceTrendingReportResponseBodyDataOutbound[];
+  /**
+   * @remarks
+   * Overall metrics.
+   */
   overall?: GetInstanceTrendingReportResponseBodyDataOverall[];
   static names(): { [key: string]: string } {
     return {
@@ -178,18 +234,38 @@ export class GetInstanceTrendingReportResponseBodyData extends $dara.Model {
 
 export class GetInstanceTrendingReportResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: GetInstanceTrendingReportResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 943D8EF3-3321-471F-A104-51C96FCA94D6
    */

package/src/models/GetIvrTrackingSummaryRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetIvrTrackingSummaryRequest extends $dara.Model {
   /**
    * @remarks
+   * The call ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class GetIvrTrackingSummaryRequest extends $dara.Model {
   contactId?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetIvrTrackingSummaryResponseBody.ts

@@ -4,22 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetIvrTrackingSummaryResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Returned data result.
+   * 
+   * @example
+   * 无
+   */
   data?: string;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * Error message.
+   * 
    * @example
    * Unknown error code \\"NoPermission.Recording\\". Reason: null
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE
    */

package/src/models/GetLoginDetailsRequest.ts

@@ -3,9 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetLoginDetailsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Chat Device ID.
+   * 
+   * @example
+   * 4c51c9116c36537cb850dc1081d745df
+   */
   chatDeviceId?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +22,9 @@ export class GetLoginDetailsRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Agent ID. This parameter is optional. If not specified, the agent mapped to the current RAM account is used by default.
+   * 
    * @example
    * agent@ccc-test
    */