@alicloud/ccc20200701 2.38.1 → 2.38.3

package/src/models/ImportCorpNumbersRequest.ts

@@ -3,22 +3,57 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ImportCorpNumbersRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The city.
+   * 
+   * @example
+   * 西安
+   */
   city?: string;
+  /**
+   * @remarks
+   * The enterprise name.
+   * 
+   * @example
+   * xxx公司
+   */
   corpName?: string;
   /**
    * @remarks
+   * The list of numbers.
+   * 
    * This parameter is required.
    * 
    * @example
-   * [\\"02912345678\\"]
+   * [\\"029xxxxxx\\"]
    */
   numberList?: string;
   /**
    * @remarks
+   * The line information.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * xxx通信-陕西线路
    */
   provider?: string;
+  /**
+   * @remarks
+   * The province.
+   * 
+   * @example
+   * 陕西
+   */
   province?: string;
+  /**
+   * @remarks
+   * The business tags.
+   * 
+   * @example
+   * 无
+   */
   tagList?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ImportCorpNumbersResponseBody.ts

@@ -4,17 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ImportCorpNumbersResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The error message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C42981C7-93D9-55CD-B078-784F8522E0E1
    */

package/src/models/ImportCustomCallTaggingRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ImportCustomCallTaggingRequest extends $dara.Model {
   /**
    * @remarks
+   * The ObjectKey of the OSS object that contains the inbound number mark file. OSS is configured with the public customer storage bucket for Cloud Call Center. You can upload the inbound number mark file to this public customer storage bucket through the inbound management page of Cloud Call Center. After the upload succeeds, invoking this API reads the file content from OSS and imports it in batch. We do not recommend directly invoking this API. Instead, you can perform this operation through the default public cloud CRM System provided by Cloud Call Center.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ImportCustomCallTaggingRequest extends $dara.Model {
   filePath?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ImportCustomCallTaggingResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ImportCustomCallTaggingResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The number of the inbound number tag that failed to be created.
+   * 
    * @example
    * 1312121****
    */
   item?: string;
   /**
+   * @remarks
+   * The reason why the inbound number tag creation failed.
+   * 
    * @example
    * CUSTOM_NUMBER_DUPLICATED
    */
@@ -38,18 +44,38 @@ export class ImportCustomCallTaggingResponseBodyData extends $dara.Model {
 
 export class ImportCustomCallTaggingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The list of inbound number tags that failed to be created.
+   */
   data?: ImportCustomCallTaggingResponseBodyData[];
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * BA03159C-E808-4FF1-B27E-A61B6E888D7F
    */

package/src/models/ImportDoNotCallNumbersRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ImportDoNotCallNumbersRequest extends $dara.Model {
   /**
+   * @remarks
+   * The key of the OSS file. You can obtain the key from the response of the GetDoNotCallFileUploadParameters API. This parameter is required only for file uploads.
+   * 
    * @example
    * temp/blacklist/import/15772471154xxxx/ccc-test/20220315100340/blacklist.xlsx
    */
   filePath?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,10 +22,20 @@ export class ImportDoNotCallNumbersRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * A JSON string that represents an array of do-not-call numbers.
+   * 
    * @example
    * ["1900000****","1312121****"]
    */
   numberList?: string;
+  /**
+   * @remarks
+   * The remark for the do-not-call numbers.
+   * 
+   * @example
+   * 测试
+   */
   remark?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ImportDoNotCallNumbersResponseBody.ts

@@ -4,18 +4,34 @@ import * as $dara from '@darabonba/typescript';
 
 export class ImportDoNotCallNumbersResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   params?: string[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * BA03159C-E808-4FF1-B27E-A61B6E888D7F
    */

package/src/models/ImportDocumentsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ImportDocumentsRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ImportDocumentsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * The key of the OSS file.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,13 +24,16 @@ export class ImportDocumentsRequest extends $dara.Model {
    */
   ossFileKey?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 7BEEA660-A45A-45E3-98CC-AFC65E715C23
    */
   requestId?: string;
   /**
    * @remarks
-   * schema id
+   * The schema ID.
    * 
    * This parameter is required.
    * 

package/src/models/ImportDocumentsResponseBody.ts

@@ -4,18 +4,38 @@ import * as $dara from '@darabonba/typescript';
 
 export class ImportDocumentsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
+  /**
+   * @remarks
+   * The response parameters.
+   */
   params?: string[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 01B12EE4-6AF2-4730-8B78-EC15F4E5C025
    */

package/src/models/ImportRamUsersRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ImportRamUsersRequest extends $dara.Model {
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ImportRamUsersRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * List of RAM user IDs to add.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ImportRamUsersRequest extends $dara.Model {
   ramIdList?: string;
   /**
    * @remarks
+   * Role ID. This is the agent\\"s role in the instance after successful import. Roles include administrator, skill group leader, and agent.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,12 +34,17 @@ export class ImportRamUsersRequest extends $dara.Model {
    */
   roleId?: string;
   /**
+   * @remarks
+   * Skill level list for the skill group. This is a JSON array string. Each array element is an object with two fields: skillGroupId and skillLevel. skillGroupId is the ID of the skill group the agent wants to associate with. skillLevel is the agent\\"s skill level in that skill group. The range is 1-10. A smaller value indicates stronger business capability and the ability to handle more calls per unit of time.
+   * 
    * @example
    * [{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]
    */
   skillLevelList?: string;
   /**
    * @remarks
+   * Work mode.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ImportRamUsersResponseBody.ts

@@ -4,22 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ImportRamUsersResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * Data, import execution ID.
+   * 
    * @example
    * 1ca2b084-6f0a-454b-9851-29768a9a5832
    */
   data?: string;
   /**
+   * @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/InitiateAttendedTransferRequest.ts

@@ -3,14 +3,26 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class InitiateAttendedTransferRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The queuing priority when transferring to a skill group queue. Valid values range from 0 to 9, where 0 is the highest priority and 9 is the lowest.
+   * 
+   * @example
+   * 5
+   */
   callPriority?: number;
   /**
+   * @remarks
+   * Device ID. This parameter is meaningless and can be filled with any value.
+   * 
    * @example
    * ACC-YUNBS-1.0.10-****
    */
   deviceId?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -19,34 +31,104 @@ export class InitiateAttendedTransferRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * The call ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * job-6538214103685****
    */
   jobId?: string;
+  /**
+   * @remarks
+   * The queuing overflow threshold when the transfer target is a skill group queue. The default value is 0, which means no overflow occurs.
+   * 
+   * @example
+   * 0
+   */
   queuingOverflowThreshold?: number;
+  /**
+   * @remarks
+   * The queuing timeout period in seconds when the transfer target is a skill group queue.
+   * 
+   * @example
+   * 10
+   */
   queuingTimeoutSeconds?: number;
+  /**
+   * @remarks
+   * The call assignment type. Valid values are Automatic or Manual. If this parameter is empty, the default value is Automatic, which is also the current system\\"s default behavior. When Manual is selected, you must invoke APIs such as ClaimCall to assign the call to a specific agent.
+   * 
+   * @example
+   * Automatic
+   */
   routingType?: string;
+  /**
+   * @remarks
+   * The policy name for agent assignment when transferring to a skill group queue.
+   * 
+   * @example
+   * MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等
+   */
   strategyName?: string;
+  /**
+   * @remarks
+   * The policy parameters for agent assignment when transferring to a skill group queue.
+   * 
+   * @example
+   * 当分配策略为CUSTOMIZED时，本参数的内容为如下格式：
+   *  {
+   *   "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",
+   *   "functionName": "routing-strategy-test-2"
+   * }
+   */
   strategyParams?: string;
+  /**
+   * @remarks
+   * Ingest endpoint data, primarily used for extension requirements. Regular users do not need to concern themselves with this.
+   * 
+   * @example
+   * a=b
+   */
   tags?: string;
   /**
+   * @remarks
+   * Timeout duration for the consultation transfer, in seconds. If the transferee does not answer within the specified time, the call is disconnected. This field is optional. Default value is 30 seconds.
+   * 
    * @example
    * 60
    */
   timeoutSeconds?: number;
   /**
    * @remarks
+   * The transferee, which can be an agent ID or a skill group ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * agent2@ccc-test
    */
   transferee?: string;
+  /**
+   * @remarks
+   * The destination type for the transfer. Valid values are AGENT, SKILL_GROUP, and EXTERNAL. If this parameter is not provided, the system determines the destination type based on the format of the target number. If inaccurate detection occurs, explicitly specify this parameter.
+   * 
+   * @example
+   * SKILL_GROUP
+   */
   transfereeType?: string;
+  /**
+   * @remarks
+   * The party initiating the transfer. When transferring to an external number, this parameter specifies the caller number. This parameter is invalid when transferring to an internal agent or skill group; in such cases, the initiator is determined by the UserId parameter.
+   * 
+   * @example
+   * 无
+   */
   transferor?: string;
   /**
+   * @remarks
+   * The agent ID initiating the consultation transfer.
+   * 
    * @example
    * agent@ccc-test
    */