@alicloud/ccc20200701 2.38.1 → 2.38.3

package/src/models/ListVisitorChatMessagesRequest.ts

@@ -4,46 +4,79 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListVisitorChatMessagesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Web business channel ID.
+   * 
    * @example
    * cf584733-***-***-9699-cb77aa3b7aa6
    */
   accessChannelId?: string;
   /**
+   * @remarks
+   * Web business channel token.
+   * 
    * @example
    * 9XYGTGWtq2wXzVikKuip_zeVGl6O4VJ-l-*-*-JPofhap4P7fAevuE=
    */
   accessToken?: string;
   /**
+   * @remarks
+   * End time, in UNIX timestamp format. Unit: milliseconds.
+   * 
    * @example
    * 1650316799000
    */
   endTime?: string;
   /**
+   * @remarks
+   * Cloud Contact Center instance.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Token for the next page. Do not include this parameter in your first request. The service returns it in the response. Include it in subsequent requests.
+   * 
    * @example
    * 1737193352340::7463707254.EAUNIT
    */
   nextPageToken?: string;
   /**
+   * @remarks
+   * Number of records per page.
+   * 
    * @example
    * 100
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Sorting order. Default is descending.
+   * 
+   * Valid values:
+   * 
+   * ASC: ascending.
+   * 
+   * DESC: descending.
+   * 
    * @example
    * DESC
    */
   sortOrder?: string;
   /**
+   * @remarks
+   * Start time, in UNIX timestamp format. Unit: milliseconds.
+   * 
    * @example
    * 1647325450000
    */
   startTime?: number;
   /**
+   * @remarks
+   * Visitor ID.
+   * 
    * @example
    * fcd020fe-****-1a272a174a7d
    */

package/src/models/ListVisitorChatMessagesResponseBody.ts

@@ -3,29 +3,66 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListVisitorChatMessagesResponseBodyDataMessages extends $dara.Model {
+  /**
+   * @remarks
+   * Message content
+   * 
+   * @example
+   * {"variables":{},"text":"Hi，我是小云~ 很高兴遇见你！","contentType":"Text"}
+   */
   content?: string;
   /**
+   * @remarks
+   * Call ID
+   * 
    * @example
    * chat-65382141036853491
    */
   jobId?: string;
   /**
+   * @remarks
+   * Sender profile picture URL
+   * 
    * @example
    * http://xxxxx.com/avatar.png
    */
   senderAvatarUrl?: string;
   /**
+   * @remarks
+   * Sender user ID
+   * 
    * @example
    * fcd020fe-****-1a272a174a7d
    */
   senderId?: string;
+  /**
+   * @remarks
+   * Sender name
+   * 
+   * @example
+   * 访客1
+   */
   senderName?: string;
   /**
+   * @remarks
+   * Sender type
+   * 
+   * Valid values:
+   * 
+   * - **ADMIN**: system
+   * 
+   * - **CUSTOMER**: visitor
+   * 
+   * - **AGENT**: agent
+   * 
    * @example
    * CUSTOMER
    */
   senderType?: string;
   /**
+   * @remarks
+   * UNIX timestamp
+   * 
    * @example
    * 1696126980371
    */
@@ -64,8 +101,15 @@ export class ListVisitorChatMessagesResponseBodyDataMessages extends $dara.Model
 }
 
 export class ListVisitorChatMessagesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Message list
+   */
   messages?: ListVisitorChatMessagesResponseBodyDataMessages[];
   /**
+   * @remarks
+   * Token for the next page
+   * 
    * @example
    * 1737193352340::7463707254.EAUNIT
    */
@@ -98,20 +142,37 @@ export class ListVisitorChatMessagesResponseBodyData extends $dara.Model {
 
 export class ListVisitorChatMessagesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data
+   */
   data?: ListVisitorChatMessagesResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * Request ID
    * 
    * @example
    * 8707EB29-BAED-4302-B999-40BA61877437

package/src/models/ListVoicemailsRequest.ts

@@ -4,22 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListVoicemailsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The calling number.
+   * 
    * @example
    * 073xxxx7539
    */
   caller?: string;
   /**
+   * @remarks
+   * The ID of the call. You can use this parameter to query the record of a specific call. You can obtain the contact ID from the softphone SDK during a call. If you specify this parameter, other query parameters are ignored.
+   * 
    * @example
    * job-125152394144124921
    */
   contactId?: string;
   /**
+   * @remarks
+   * The end time of the query range. This is a UNIX timestamp in milliseconds. The default value is the current time.
+   * 
    * @example
    * 1532707199000
    */
   endTime?: number;
   /**
    * @remarks
+   * The ID of the Cloud Contact Center (CC) instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -27,6 +38,9 @@ export class ListVoicemailsRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The name of the voicemail.
+   * 
    * @example
    * voicemail-test
    * 
@@ -35,6 +49,8 @@ export class ListVoicemailsRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
+   * The page number. Valid values: 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -43,6 +59,8 @@ export class ListVoicemailsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * The number of entries per page. Valid values: 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -50,6 +68,9 @@ export class ListVoicemailsRequest extends $dara.Model {
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The start time of the query range. This is a UNIX timestamp in milliseconds. The default value is 00:00 on the current day.
+   * 
    * @example
    * 1532448000000
    */

package/src/models/ListVoicemailsResponseBody.ts

@@ -4,38 +4,73 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListVoicemailsResponseBodyDataList extends $dara.Model {
   /**
+   * @remarks
+   * The called number.
+   * 
    * @example
    * 0533128****
    */
   callee?: string;
   /**
+   * @remarks
+   * The calling number.
+   * 
    * @example
    * 073xxxx7539
    */
   caller?: string;
+  /**
+   * @remarks
+   * The start time of the call.
+   * 
+   * @example
+   * 1532448000000，已废弃，请使用StartTime。
+   */
   cdrStartTime?: number;
   /**
+   * @remarks
+   * The call ID.
+   * 
    * @example
    * job-125152394144124921
    */
   contactId?: string;
   /**
+   * @remarks
+   * The duration of the voicemail message in seconds.
+   * 
    * @example
    * 16
    */
   duration?: number;
   /**
+   * @remarks
+   * The ID of the CC instance.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The name of the voicemail.
+   * 
    * @example
    * voicemail-test
    */
   name?: string;
+  /**
+   * @remarks
+   * The duration of the voicemail message in seconds.
+   * 
+   * @example
+   * 10，已废弃，请使用Duration
+   */
   recordingDuration?: number;
   /**
+   * @remarks
+   * The start time of the voicemail.
+   * 
    * @example
    * 1631440860000
    */
@@ -78,18 +113,31 @@ export class ListVoicemailsResponseBodyDataList extends $dara.Model {
 }
 
 export class ListVoicemailsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of voicemail records.
+   */
   list?: ListVoicemailsResponseBodyDataList[];
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of entries. This parameter is returned only when \\`PageNumber\\` is set to 1. For other values of \\`PageNumber\\`, this parameter returns 0.
+   * 
    * @example
    * 11
    */
@@ -126,18 +174,38 @@ export class ListVoicemailsResponseBodyData extends $dara.Model {
 
 export class ListVoicemailsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The data.
+   */
   data?: ListVoicemailsResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
    */

package/src/models/ListWaitingChatsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListWaitingChatsRequest extends $dara.Model {
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,6 +14,9 @@ export class ListWaitingChatsRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Skill group ID list.
+   * 
    * @example
    * ["skillgroup1@ccc-test", "skillgroup2@ccc-test"]
    */

package/src/models/ListWaitingChatsResponseBody.ts

@@ -3,12 +3,33 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListWaitingChatsResponseBodyDataMessages extends $dara.Model {
+  /**
+   * @remarks
+   * Message content.
+   * 
+   * @example
+   * 测试消息
+   */
   content?: string;
   /**
+   * @remarks
+   * Message sender ID.
+   * 
    * @example
    * c361765f-******-4e07-b81c-4b5d9183fac6
    */
   senderId?: string;
+  /**
+   * @remarks
+   * Sender type. Valid values:
+   * 
+   * - **CUSTOMER**: visitor
+   * 
+   * - **AGENT**: agent
+   * 
+   * @example
+   * {"variables":{},"text":"<p>这种的名片选单面还是双面</p>"}
+   */
   senderType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -36,14 +57,34 @@ export class ListWaitingChatsResponseBodyDataMessages extends $dara.Model {
 }
 
 export class ListWaitingChatsResponseBodyDataUserList extends $dara.Model {
+  /**
+   * @remarks
+   * Profile picture URL.
+   * 
+   * @example
+   * 无
+   */
   avatarUrl?: string;
   /**
+   * @remarks
+   * User ID.
+   * 
    * @example
    * c361765f-******-4e07-b81c-4b5d9183fac6
    */
   userId?: string;
+  /**
+   * @remarks
+   * User name.
+   * 
+   * @example
+   * 访客-1c***
+   */
   userName?: string;
   /**
+   * @remarks
+   * User type.
+   * 
    * @example
    * CUSTOMER
    */
@@ -77,37 +118,70 @@ export class ListWaitingChatsResponseBodyDataUserList extends $dara.Model {
 
 export class ListWaitingChatsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Access channel ID.
+   * 
    * @example
    * 843073c2-*****-49fb-a616-738ddddfebdc
    */
   accessChannelId?: string;
   /**
+   * @remarks
+   * Access channel type.
+   * 
    * @example
    * Web
    */
   accessChannelType?: string;
   /**
+   * @remarks
+   * Indicates whether the session has been assigned to an agent.
+   * 
    * @example
    * false
    */
   beingAssigned?: boolean;
   /**
+   * @remarks
+   * Chat session ID.
+   * 
    * @example
    * $23086709$EAUNIT
    */
   chatConversationId?: string;
   /**
+   * @remarks
+   * Enqueue time, in Unix timestamp format, in milliseconds.
+   * 
    * @example
    * 1718868572094
    */
   enqueueTime?: number;
   /**
+   * @remarks
+   * Job ID.
+   * 
    * @example
    * chat-434537064047960064
    */
   jobId?: string;
+  /**
+   * @remarks
+   * Message list.
+   */
   messages?: ListWaitingChatsResponseBodyDataMessages[];
+  /**
+   * @remarks
+   * The skill group information.
+   * 
+   * @example
+   * skill@ccc-test
+   */
   skillGroupId?: string;
+  /**
+   * @remarks
+   * User list.
+   */
   userList?: ListWaitingChatsResponseBodyDataUserList[];
   static names(): { [key: string]: string } {
     return {
@@ -154,18 +228,38 @@ export class ListWaitingChatsResponseBodyData extends $dara.Model {
 
 export class ListWaitingChatsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Returned data.
+   */
   data?: ListWaitingChatsResponseBodyData[];
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 03C67DAD-EB26-41D8-949D-9B0C470FB716
    */

package/src/models/MakeCallRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class MakeCallRequest extends $dara.Model {
   /**
    * @remarks
+   * Callee number. For internal calls, specify the target agent\\"s extension number in this field. For outbound calls, specify the customer\\"s phone number.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,18 +14,33 @@ export class MakeCallRequest extends $dara.Model {
    */
   callee?: string;
   /**
+   * @remarks
+   * Caller number. This parameter is invalid for internal calls. For outbound calls, specify an outbound number available to the current agent. Ensure that the number supports outbound calling and that the agent has permission to use it. Permission can be granted in two ways: either by attaching the number to the skill group the agent signed into, or by setting the number as the agent\\"s personal outbound number.
+   * 
    * @example
    * 010989****
    */
   caller?: string;
   /**
+   * @remarks
+   * Device ID. This field is meaningless and can be filled with any value.
+   * 
    * @example
    * device
    */
   deviceId?: string;
+  /**
+   * @remarks
+   * Flash SMS configuration
+   * 
+   * @example
+   * {\\"applicationId\\":\\"6bd18325-ea7f-4881-8902-4d06283d3b3b\\",\\"templateId\\":\\"1722217249064\\"}
+   */
   flashSmsVariables?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -31,22 +48,41 @@ export class MakeCallRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The desensitized callee number. If this field is not empty, it indicates that the callee number must be desensitized. The desensitization rule is defined by the customer. You only need to enter the desensitized callee number here. Using a desensitized callee number means that in certain scenarios, you will see the desensitized callee number and cannot view the real callee number.
+   * 
    * @example
    * 131****8888
    */
   maskedCallee?: string;
+  /**
+   * @remarks
+   * Media type. The default value is AUDIO. Other valid values include VIDEO.
+   * 
+   * @example
+   * AUDIO
+   */
   mediaType?: string;
   /**
+   * @remarks
+   * Ingest endpoint data. The customer does not need to concern themselves with this.
+   * 
    * @example
    * tags
    */
   tags?: string;
   /**
+   * @remarks
+   * Timeout. If the call is not answered within the time specified by this parameter, the system automatically hangs up. Valid values range from 30 to 300 seconds.
+   * 
    * @example
    * 30
    */
   timeoutSeconds?: number;
   /**
+   * @remarks
+   * Agent ID initiating the outbound call. This field is optional. If not specified, the system uses the agent mapped to the current RAM user by default.
+   * 
    * @example
    * agent@ccc-test
    */