@alicloud/ccc20200701 2.38.2 → 2.39.0

package/src/models/ListInstancesOfUserRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListInstancesOfUserRequest extends $dara.Model {
   /**
    * @remarks
+   * Paging ordinal number, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ListInstancesOfUserRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * Paging size, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListInstancesOfUserResponseBody.ts

@@ -3,48 +3,82 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListInstancesOfUserResponseBodyDataListAdminList extends $dara.Model {
+  /**
+   * @remarks
+   * The administrator\\"s name.
+   * 
+   * @example
+   * 测试坐席
+   */
   displayName?: string;
   /**
+   * @remarks
+   * Mailbox.
+   * 
    * @example
    * username@example.com
    */
   email?: string;
   /**
+   * @remarks
+   * Agent extension number.
+   * 
    * @example
    * 8032****
    */
   extension?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Agent logon name.
+   * 
    * @example
    * agent
    */
   loginName?: string;
   /**
+   * @remarks
+   * The agent\\"s personal phone number.
+   * 
    * @example
    * 1382114****
    */
   mobile?: string;
   /**
+   * @remarks
+   * The role ID, in the format: role\\@instance ID.
+   * 
    * @example
    * Admin@ccc-test
    */
   roleId?: string;
   /**
+   * @remarks
+   * Role name.
+   * 
    * @example
    * Admin
    */
   roleName?: string;
   /**
+   * @remarks
+   * Agent ID.
+   * 
    * @example
    * agent@ccc-test
    */
   userId?: string;
   /**
+   * @remarks
+   * Work mode.
+   * 
    * @example
    * ON_SITE
    */
@@ -89,29 +123,58 @@ export class ListInstancesOfUserResponseBodyDataListAdminList extends $dara.Mode
 }
 
 export class ListInstancesOfUserResponseBodyDataListNumberListSkillGroups extends $dara.Model {
+  /**
+   * @remarks
+   * Skill group description.
+   * 
+   * @example
+   * 云联络中心的测试技能组。
+   */
   description?: string;
+  /**
+   * @remarks
+   * The display name of the skill group.
+   * 
+   * @example
+   * 测试技能组
+   */
   displayName?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The name of the skill group.
+   * 
    * @example
    * skillgroup
    */
   name?: string;
   /**
+   * @remarks
+   * 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
    * 2
    */
@@ -151,34 +214,70 @@ export class ListInstancesOfUserResponseBodyDataListNumberListSkillGroups extend
 
 export class ListInstancesOfUserResponseBodyDataListNumberList extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the number is active.
+   * 
    * @example
    * true
    */
   active?: boolean;
+  /**
+   * @remarks
+   * The city of the phone number\\"s registration location.
+   * 
+   * @example
+   * 乐山
+   */
   city?: string;
   /**
+   * @remarks
+   * The contact flow ID (IVR) associated with this phone number.
+   * 
    * @example
    * a3fb6c62-9b49-4942-ae5b-cf2abd4123ek
    */
   contactFlowId?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The number.
+   * 
    * @example
    * 0830011****
    */
   number?: string;
+  /**
+   * @remarks
+   * The province of the phone number\\"s registration location.
+   * 
+   * @example
+   * 四川
+   */
   province?: string;
+  /**
+   * @remarks
+   * List of skill groups associated with the phone number.
+   */
   skillGroups?: ListInstancesOfUserResponseBodyDataListNumberListSkillGroups[];
   /**
+   * @remarks
+   * The usage of the number.
+   * 
    * @example
    * Bidirection
    */
   usage?: string;
   /**
+   * @remarks
+   * Agent ID. If this parameter is not empty, the number is a personal outbound number assigned to the agent.
+   * 
    * @example
    * agent@ccc-test
    */
@@ -224,31 +323,68 @@ export class ListInstancesOfUserResponseBodyDataListNumberList extends $dara.Mod
 }
 
 export class ListInstancesOfUserResponseBodyDataList extends $dara.Model {
+  /**
+   * @remarks
+   * Administrator list.
+   */
   adminList?: ListInstancesOfUserResponseBodyDataListAdminList[];
   /**
+   * @remarks
+   * The Alibaba Cloud Account ID to which the instance belongs.
+   * 
    * @example
    * 157123456789****
    */
   aliyunUid?: string;
   /**
+   * @remarks
+   * The URL of the Cloud Contact Center instance, used to access the homepage of the Cloud Contact Center instance. It consists of the specific Cloud Contact Center URL followed by the instance ID.
+   * 
    * @example
    * https://ccc-v2.aliyun.com/#/workbench/ccc-test
    */
   consoleUrl?: string;
+  /**
+   * @remarks
+   * The instance description.
+   * 
+   * @example
+   * 云联络中心的测试实例。
+   */
   description?: string;
   /**
+   * @remarks
+   * The domain name of the instance, which 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
+   * List of numbers.
+   */
   numberList?: ListInstancesOfUserResponseBodyDataListNumberList[];
   /**
+   * @remarks
+   * Instance status.
+   * 
    * @example
    * RUNNING
    */
@@ -297,18 +433,31 @@ export class ListInstancesOfUserResponseBodyDataList extends $dara.Model {
 }
 
 export class ListInstancesOfUserResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * List.
+   */
   list?: ListInstancesOfUserResponseBodyDataList[];
   /**
+   * @remarks
+   * Page number, ranging from 1 to 100.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * Page size, ranging from 1 to 100.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 10
    */
@@ -345,18 +494,38 @@ export class ListInstancesOfUserResponseBodyData extends $dara.Model {
 
 export class ListInstancesOfUserResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: ListInstancesOfUserResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 3969FC68-CEC2-4398-B76A-60D2F7EDEBAF
    */

package/src/models/ListInstancesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListInstancesRequest extends $dara.Model {
   /**
    * @remarks
+   * The paging ordinal number, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ListInstancesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * The paging size, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListInstancesResponseBody.ts

@@ -3,48 +3,82 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListInstancesResponseBodyDataListAdminList extends $dara.Model {
+  /**
+   * @remarks
+   * The administrator\\"s name.
+   * 
+   * @example
+   * 测试坐席
+   */
   displayName?: string;
   /**
+   * @remarks
+   * Mailbox.
+   * 
    * @example
    * username@example.com
    */
   email?: string;
   /**
+   * @remarks
+   * Agent extension number.
+   * 
    * @example
    * 8032****
    */
   extension?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Agent logon name.
+   * 
    * @example
    * agent
    */
   loginName?: string;
   /**
+   * @remarks
+   * The agent\\"s personal phone number.
+   * 
    * @example
    * 1382114****
    */
   mobile?: string;
   /**
+   * @remarks
+   * The role ID, in the format: role\\@instance ID.
+   * 
    * @example
    * Admin@ccc-test
    */
   roleId?: string;
   /**
+   * @remarks
+   * Role name.
+   * 
    * @example
    * Admin
    */
   roleName?: string;
   /**
+   * @remarks
+   * Agent ID.
+   * 
    * @example
    * agent@ccc-test
    */
   userId?: string;
   /**
+   * @remarks
+   * Work mode.
+   * 
    * @example
    * ON_SITE
    */
@@ -90,6 +124,9 @@ export class ListInstancesResponseBodyDataListAdminList extends $dara.Model {
 
 export class ListInstancesResponseBodyDataListNumberList extends $dara.Model {
   /**
+   * @remarks
+   * The number.
+   * 
    * @example
    * 0830011****
    */
@@ -116,36 +153,76 @@ export class ListInstancesResponseBodyDataListNumberList extends $dara.Model {
 }
 
 export class ListInstancesResponseBodyDataList extends $dara.Model {
+  /**
+   * @remarks
+   * Administrator list.
+   */
   adminList?: ListInstancesResponseBodyDataListAdminList[];
   /**
+   * @remarks
+   * The Alibaba Cloud account ID to which the instance belongs.
+   * 
    * @example
    * 157123456789****
    */
   aliyunUid?: string;
   /**
+   * @remarks
+   * The URL of the Cloud Contact Center instance, used to access the homepage of the Cloud Call Center instance. It is composed of the specific Cloud Call Center URL followed by the instance ID.
+   * 
    * @example
    * https://ccc-v2.aliyun.com/#/workbench/ccc-test
    */
   consoleUrl?: string;
   /**
+   * @remarks
+   * The creation time of the instance.
+   * 
    * @example
    * 1624679747000
    */
   createTime?: number;
+  /**
+   * @remarks
+   * The instance description.
+   * 
+   * @example
+   * 云联络中心的测试实例。
+   */
   description?: string;
   /**
+   * @remarks
+   * The domain name of the instance, which 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?: ListInstancesResponseBodyDataListNumberList[];
   /**
+   * @remarks
+   * Instance status.
+   * 
    * @example
    * RUNNING
    */
@@ -196,18 +273,31 @@ export class ListInstancesResponseBodyDataList extends $dara.Model {
 }
 
 export class ListInstancesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * List.
+   */
   list?: ListInstancesResponseBodyDataList[];
   /**
+   * @remarks
+   * Page number, ranging from 1 to 100.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * Page size, ranging from 1 to 100.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 10
    */
@@ -244,18 +334,38 @@ export class ListInstancesResponseBodyData extends $dara.Model {
 
 export class ListInstancesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: ListInstancesResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 26A34338-5CD9-4C95-A7A6-5BDCE76C6B94
    */

package/src/models/ListIntervalAgentReportRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListIntervalAgentReportRequest extends $dara.Model {
   /**
    * @remarks
+   * Agent ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class ListIntervalAgentReportRequest extends $dara.Model {
    */
   agentId?: string;
   /**
+   * @remarks
+   * End time, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is the current time. If Interval is Daily, the maximum interval between StartTime and EndTime is 180 days. If Interval is Hourly, the maximum interval is 10 days. Time precision for statistics is at the hour level, rounded down to the next full hour, using an open interval. For example, if the start time is 11:12:20 and the end time is 11:45:50, the aligned input time range becomes [11:00:00, 12:00:00), meaning greater than or equal to 11:00:00 and less than 12:00:00.
+   * 
    * @example
    * 1532707199000
    */
   endTime?: number;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,12 +32,25 @@ export class ListIntervalAgentReportRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Segment statistics type. Optional. Default value is Daily (aggregated by Day).
+   * 
    * @example
    * Hourly
    */
   interval?: string;
+  /**
+   * @remarks
+   * Media type. The default value is Audio. Other valid values include Chat and Video.
+   * 
+   * @example
+   * VIDEO
+   */
   mediaType?: string;
   /**
+   * @remarks
+   * Start time, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is 00:00:00 of the current day. Time precision for statistics is at the hour level, rounded down to the previous full hour, using a closed interval.
+   * 
    * @example
    * 1532448000000
    */