@alicloud/ccc20200701 2.38.2 → 2.39.0

package/src/models/ListAttemptsResponseBody.ts

@@ -4,101 +4,161 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAttemptsResponseBodyDataList extends $dara.Model {
   /**
+   * @remarks
+   * The time when the agent answered the call, in Unix timestamp format, in milliseconds.
+   * 
    * @example
    * 1632883592732
    */
   agentEstablishedTime?: number;
   /**
+   * @remarks
+   * Agent ID.
+   * 
    * @example
    * agent@ccc-test
    */
   agentId?: string;
   /**
+   * @remarks
+   * Agent ring duration, in seconds.
+   * 
    * @example
    * 23
    */
   agentRingDuration?: number;
   /**
+   * @remarks
+   * The time when the agent was assigned, formatted as a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1634196287869
    */
   assignAgentTime?: number;
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-1704342174816****
    */
   attemptId?: string;
   /**
+   * @remarks
+   * Callee number.
+   * 
    * @example
    * 1888888****
    */
   callee?: string;
   /**
+   * @remarks
+   * Calling number.
+   * 
    * @example
    * 05711234****
    */
   caller?: string;
   /**
+   * @remarks
+   * Predictive outbound dialing Activity ID.
+   * 
    * @example
    * 083046e3-5822-4cda-9b84-04f2a02eb605
    */
   campaignId?: string;
   /**
+   * @remarks
+   * A contact ID generated by the system. Customers do not need to be concerned with this value.
+   * 
    * @example
    * 21d194a7-60b7-4824-932b-48ed03a83704
    */
   caseId?: string;
   /**
+   * @remarks
+   * The call ID.
+   * 
    * @example
    * job-1704342174816****
    */
   contactId?: string;
   /**
+   * @remarks
+   * The time when the Customer answered the call, formatted as a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1634196286708
    */
   customerEstablishedTime?: number;
   /**
+   * @remarks
+   * The time when the Customer hung up, formatted as a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1634196317888
    */
   customerReleasedTime?: number;
   /**
+   * @remarks
+   * The dial-up duration, in seconds.
+   * 
    * @example
    * 2734
    */
   dialDuration?: number;
   /**
+   * @remarks
+   * Time when the dial-up was initiated, in UNIX timestamp format, in milliseconds.
+   * 
    * @example
    * 1634196283974
    */
   dialTime?: number;
   /**
+   * @remarks
+   * The time when the contact entered the queue, in Unix timestamp format, in milliseconds.
+   * 
    * @example
    * 1634196287789
    */
   enqueueTime?: number;
   /**
+   * @remarks
+   * The time when the call was transferred into IVR, formatted as a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1634196286740
    */
   enterIvrTime?: number;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The duration spent in IVR, in seconds.
+   * 
    * @example
    * 1049
    */
   ivrDuration?: number;
   /**
+   * @remarks
+   * The queue duration, in seconds.
+   * 
    * @example
    * 80
    */
   queueDuration?: number;
   /**
+   * @remarks
+   * The skill group ID.
+   * 
    * @example
    * skillgroup@ccc-test
    */
@@ -163,18 +223,31 @@ export class ListAttemptsResponseBodyDataList extends $dara.Model {
 }
 
 export class ListAttemptsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * List of contact dialing records.
+   */
   list?: ListAttemptsResponseBodyDataList[];
   /**
+   * @remarks
+   * Page number. The product of PageNumber and PageSize must not exceed 10 000.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * Page size. The product of PageNumber and PageSize must not exceed 10 000.
+   * 
    * @example
    * 100
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 1
    */
@@ -211,18 +284,38 @@ export class ListAttemptsResponseBodyData extends $dara.Model {
 
 export class ListAttemptsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: ListAttemptsResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 7CC6523B-0E51-1B62-8DA5-6A9831CAE315
    */

package/src/models/ListAudioFilesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListAudioFilesRequest extends $dara.Model {
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ListAudioFilesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * The paging ordinal number, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,13 +25,32 @@ export class ListAudioFilesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * Page size, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
    * 10
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * Converting (transforming)<br>
+   * Completed (transformation completed)<br>
+   * Failed (transformation failed)<br>
+   * If this parameter is not specified, resources in all statuses are queried.
+   * 
+   * @example
+   * Completed
+   */
   status?: string;
+  /**
+   * @remarks
+   * Purpose of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music during calls).
+   * 
+   * @example
+   * General
+   */
   usage?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListAudioFilesResponseBody.ts

@@ -4,38 +4,84 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAudioFilesResponseBodyDataList extends $dara.Model {
   /**
+   * @remarks
+   * Audio file name.
+   * 
    * @example
    * test-file.wav
    */
   audioFileName?: string;
   /**
+   * @remarks
+   * Audio resource ID, which is the UUID of the audio file.
+   * 
    * @example
    * d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77
    */
   audioResourceId?: string;
+  /**
+   * @remarks
+   * Audio content threat review result.
+   * 
+   * @example
+   * 无
+   */
   auditResult?: string;
   /**
+   * @remarks
+   * The creation time of the audio resource.
+   * 
    * @example
    * 2021-03-05 17:35:45.0
    */
   createdTime?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * Display name of the audio resource.
+   * 
+   * @example
+   * 欢迎语
+   */
   name?: string;
   /**
+   * @remarks
+   * The key of the audio resource file in OSS.
+   * 
    * @example
    * ccc-test/test-file.wav
    */
   ossFileKey?: string;
+  /**
+   * @remarks
+   * The status of the audio file.
+   * 
+   * @example
+   * Completed
+   */
   status?: string;
   /**
+   * @remarks
+   * Last modified time of the audio resource.
+   * 
    * @example
    * 2021-03-08 15:34:49.0
    */
   updatedTime?: string;
+  /**
+   * @remarks
+   * The usage of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music during call waiting).
+   * 
+   * @example
+   * General
+   */
   usage?: string;
   static names(): { [key: string]: string } {
     return {
@@ -77,18 +123,31 @@ export class ListAudioFilesResponseBodyDataList extends $dara.Model {
 }
 
 export class ListAudioFilesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of audio files.
+   */
   list?: ListAudioFilesResponseBodyDataList[];
   /**
+   * @remarks
+   * The page number, ranging from 1 to 100.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The paging size, ranging from 1 to 100.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total count.
+   * 
    * @example
    * 10
    */
@@ -125,18 +184,38 @@ export class ListAudioFilesResponseBodyData extends $dara.Model {
 
 export class ListAudioFilesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The data.
+   */
   data?: ListAudioFilesResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 53223330-EBF1-586B-A2CB-93C3B711FDA0
    */

package/src/models/ListBlacklistCallTaggingsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListBlacklistCallTaggingsRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the Cloud Contact Center instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ListBlacklistCallTaggingsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * A list of numbers to query for their blacklist tag status. The jobId field is required if a number is encrypted (contains \\*\\*\\*).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListBlacklistCallTaggingsResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListBlacklistCallTaggingsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the number has a blacklist tag.
+   * 
    * @example
    * true
    */
   blacklisted?: boolean;
   /**
+   * @remarks
+   * The call ID.
+   * 
    * @example
    * job-481841171213393920
    */
   jobId?: string;
   /**
+   * @remarks
+   * The phone number.
+   * 
    * @example
    * 1521083xxxx
    */
@@ -45,16 +54,33 @@ export class ListBlacklistCallTaggingsResponseBodyData extends $dara.Model {
 
 export class ListBlacklistCallTaggingsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The data.
+   */
   data?: ListBlacklistCallTaggingsResponseBodyData[];
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
    * @remarks

package/src/models/ListBriefSkillGroupsRequest.ts

@@ -5,15 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class ListBriefSkillGroupsRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * ccc-test
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The media type. The default value is AUDIO. Other valid values include CHAT and VIDEO.
+   * 
+   * @example
+   * CHAT
+   */
   mediaType?: string;
   /**
    * @remarks
+   * The page number for paging, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,6 +33,8 @@ export class ListBriefSkillGroupsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * The page size for paging, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +42,9 @@ export class ListBriefSkillGroupsRequest extends $dara.Model {
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Perform fuzzy matching based on the skill group name or display name. This parameter is optional and defaults to empty, which means no filtering is applied.
+   * 
    * @example
    * skillgroup
    */

package/src/models/ListBriefSkillGroupsResponseBody.ts

@@ -3,30 +3,66 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListBriefSkillGroupsResponseBodyDataList extends $dara.Model {
+  /**
+   * @remarks
+   * Description of the skill group.
+   * 
+   * @example
+   * 云联络中心的测试技能组。
+   */
   description?: string;
+  /**
+   * @remarks
+   * The display name of the skill group.
+   * 
+   * @example
+   * 测试技能组
+   */
   displayName?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The media type. The default value is AUDIO. Other valid values include CHAT and VIDEO.
+   * 
+   * @example
+   * VIDEO
+   */
   mediaType?: string;
   /**
+   * @remarks
+   * Quantity of phone numbers associated with the skill group.
+   * 
    * @example
    * 1
    */
   phoneNumberCount?: number;
   /**
+   * @remarks
+   * The skill group ID.
+   * 
    * @example
    * skillgroup@ccc-test
    */
   skillGroupId?: string;
   /**
+   * @remarks
+   * Name of the skill group.
+   * 
    * @example
    * skillgroup
    */
   skillGroupName?: string;
   /**
+   * @remarks
+   * The number of agents associated with the skill group.
+   * 
    * @example
    * 10
    */
@@ -67,18 +103,31 @@ export class ListBriefSkillGroupsResponseBodyDataList extends $dara.Model {
 }
 
 export class ListBriefSkillGroupsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * List of skill group summary information.
+   */
   list?: ListBriefSkillGroupsResponseBodyDataList[];
   /**
+   * @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
    */
@@ -115,18 +164,38 @@ export class ListBriefSkillGroupsResponseBodyData extends $dara.Model {
 
 export class ListBriefSkillGroupsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: ListBriefSkillGroupsResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 3969FC68-CEC2-4398-B76A-60D2F7EDEBAF
    */