@alicloud/ccc20200701 2.38.2 → 2.38.3

package/src/models/MakeCallResponseBody.ts

@@ -4,54 +4,105 @@ import * as $dara from '@darabonba/typescript';
 
 export class MakeCallResponseBodyDataCallContextChannelContexts extends $dara.Model {
   /**
+   * @remarks
+   * The call type of the channel.
+   * 
    * @example
    * OUTBOUND
    */
   callType?: string;
   /**
+   * @remarks
+   * Channel flags.
+   * 
    * @example
    * MONITORING
    */
   channelFlags?: string;
   /**
+   * @remarks
+   * The channel ID.
+   * 
    * @example
    * ch:user:1390501****->8032****:1609138902226:job-653821410368****
    */
   channelId?: string;
   /**
+   * @remarks
+   * The status of the call channel.
+   * 
    * @example
    * NONE
    */
   channelState?: string;
   /**
+   * @remarks
+   * Callee of the call channel.
+   * 
    * @example
    * 8001****
    */
   destination?: string;
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-6570007401392****
    */
   jobId?: string;
+  /**
+   * @remarks
+   * Media type. The default value is AUDIO. Other valid values include VIDEO.
+   * 
+   * @example
+   * Audio
+   */
   mediaType?: string;
   /**
+   * @remarks
+   * The originator of the channel.
+   * 
    * @example
    * 1318888****
    */
   originator?: string;
+  /**
+   * @remarks
+   * The party that initiated the release of the call channel, indicating who hung up first.
+   * 
+   * @example
+   * 无
+   */
   releaseInitiator?: string;
+  /**
+   * @remarks
+   * The reason for releasing the channel. This value indicates why the current channel was disconnected and corresponds to a response code defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.
+   * 
+   * @example
+   * 无
+   */
   releaseReason?: string;
   /**
+   * @remarks
+   * The UNIX timestamp indicating the most recent status change of the channel, in milliseconds.
+   * 
    * @example
    * 1609225718295
    */
   timestamp?: number;
   /**
+   * @remarks
+   * The extension number of the agent associated with the channel.
+   * 
    * @example
    * 8001****
    */
   userExtension?: string;
   /**
+   * @remarks
+   * The agent ID associated with the channel. This field is empty for customer channels.
+   * 
    * @example
    * agent@ccc-test
    */
@@ -103,18 +154,38 @@ export class MakeCallResponseBodyDataCallContextChannelContexts extends $dara.Mo
 
 export class MakeCallResponseBodyDataCallContext extends $dara.Model {
   /**
+   * @remarks
+   * Call type.
+   * 
    * @example
    * OUTBOUND
    */
   callType?: string;
+  /**
+   * @remarks
+   * Ingest endpoint data. Custom data passed through SIP signaling.
+   * 
+   * @example
+   * a=b;c=d
+   */
   callVariables?: string;
+  /**
+   * @remarks
+   * List of call channels.
+   */
   channelContexts?: MakeCallResponseBodyDataCallContextChannelContexts[];
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-6570007401392****
    */
@@ -153,47 +224,78 @@ export class MakeCallResponseBodyDataCallContext extends $dara.Model {
 
 export class MakeCallResponseBodyDataUserContext extends $dara.Model {
   /**
+   * @remarks
+   * Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes, and Customers can define them according to their business needs.
+   * 
    * @example
    * Warm-up
    */
   breakCode?: string;
   /**
+   * @remarks
+   * Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.
+   * 
    * @example
    * ACC-YUNBS-1.0.10-****
    */
   deviceId?: string;
   /**
+   * @remarks
+   * Agent extension number.
+   * 
    * @example
    * 8001****
    */
   extension?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-6570007401392****
    */
   jobId?: string;
   /**
+   * @remarks
+   * Indicates whether the agent is in outbound-only mode.
+   * 
    * @example
    * false
    */
   outboundScenario?: boolean;
+  /**
+   * @remarks
+   * List of skill group IDs that the agent has signed into.
+   */
   signedSkillGroupIdList?: string[];
   /**
+   * @remarks
+   * Agent ID.
+   * 
    * @example
    * agent@ccc-test
    */
   userId?: string;
   /**
+   * @remarks
+   * Agent status.
+   * 
    * @example
    * READY
    */
   userState?: string;
   /**
+   * @remarks
+   * Work mode.
+   * 
    * @example
    * ON_SITE
    */
@@ -241,12 +343,23 @@ export class MakeCallResponseBodyDataUserContext extends $dara.Model {
 }
 
 export class MakeCallResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Call context environment.
+   */
   callContext?: MakeCallResponseBodyDataCallContext;
   /**
+   * @remarks
+   * System auto-increment ID. Customers do not need to concern themselves with this.
+   * 
    * @example
    * 123456
    */
   contextId?: number;
+  /**
+   * @remarks
+   * Agent context environment.
+   */
   userContext?: MakeCallResponseBodyDataUserContext;
   static names(): { [key: string]: string } {
     return {
@@ -281,19 +394,43 @@ export class MakeCallResponseBodyData extends $dara.Model {
 
 export class MakeCallResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: MakeCallResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
+  /**
+   * @remarks
+   * List of response parameters.
+   */
   params?: string[];
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 26A34338-5CD9-4C95-A7A6-5BDCE76C6B94
    */

package/src/models/ModifyAudioFileRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyAudioFileRequest extends $dara.Model {
   /**
    * @remarks
+   * Name of the audio file to be modified. You can specify new content for the audio file here.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ModifyAudioFileRequest extends $dara.Model {
   audioFileName?: string;
   /**
    * @remarks
+   * Audio resource ID, which uniquely identifies an audio file.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ModifyAudioFileRequest extends $dara.Model {
   audioResourceId?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,17 +35,31 @@ export class ModifyAudioFileRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * Display name of the audio file. It must be 1 to 32 characters in length. The display name cannot be changed when modifying the audio file, so you must provide the original display name here.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 欢迎语
    */
   name?: string;
   /**
    * @remarks
+   * The OSS key of the audio file to be modified.
+   * 
    * This parameter is required.
    * 
    * @example
    * ccc-test/new-test-file.wav
    */
   ossFileKey?: string;
+  /**
+   * @remarks
+   * Usage of the audio file. The default value is General (used in scenarios such as IVR). Other valid values include HoldMusic (hold music during call waiting).
+   * 
+   * @example
+   * General
+   */
   usage?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ModifyAudioFileResponseBody.ts

@@ -4,18 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyAudioFileResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   * 
+   * @example
+   * 无
+   */
   data?: string;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * D2F84AAC-7C79-547F-8EE9-7B735F42B93F
    */

package/src/models/ModifyCampaignNumbersRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCampaignNumbersRequest extends $dara.Model {
   /**
    * @remarks
+   * The campaign ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,18 +14,27 @@ export class ModifyCampaignNumbersRequest extends $dara.Model {
    */
   campaignId?: string;
   /**
+   * @remarks
+   * The ID of the number collection.
+   * 
    * @example
    * 3971876649-****-****-098763a382a09
    */
   instGroupId?: string;
   /**
    * @remarks
+   * The ID of the Cloud Call Center (CCC) instance.
+   * 
    * This parameter is required.
    * 
    * @example
    * ccc-test
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The list of numbers.
+   */
   numberList?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ModifyCampaignNumbersResponseBody.ts

@@ -4,19 +4,46 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyCampaignNumbersResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The data.
+   * 
+   * @example
+   * 无
+   */
   data?: any;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The error message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
+  /**
+   * @remarks
+   * The list of error parameters.
+   */
   params?: string[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE
    */

package/src/models/ModifyCampaignNumbersShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCampaignNumbersShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The campaign ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,18 +14,27 @@ export class ModifyCampaignNumbersShrinkRequest extends $dara.Model {
    */
   campaignId?: string;
   /**
+   * @remarks
+   * The ID of the number collection.
+   * 
    * @example
    * 3971876649-****-****-098763a382a09
    */
   instGroupId?: string;
   /**
    * @remarks
+   * The ID of the Cloud Call Center (CCC) instance.
+   * 
    * This parameter is required.
    * 
    * @example
    * ccc-test
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The list of numbers.
+   */
   numberListShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ModifyCustomCallTaggingRequest.ts

@@ -4,13 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyCustomCallTaggingRequest extends $dara.Model {
   /**
+   * @remarks
+   * A list of number tag names. You must provide the complete list of number tags to be modified, and ensure that these number tags have already been created.
+   * 
    * @example
    * ["TagA","TagB"]
    */
   callTagNameList?: string;
+  /**
+   * @remarks
+   * The new description for the inbound number mark. This parameter is optional. The default value is empty, which indicates that the description will not be modified.
+   * 
+   * @example
+   * 王先生
+   */
   description?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -19,6 +31,8 @@ export class ModifyCustomCallTaggingRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * The number associated with the inbound number mark. The system matches the inbound number mark to be modified based on this number.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyCustomCallTaggingResponseBody.ts

@@ -4,17 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyCustomCallTaggingResponseBody 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 request ID.
+   * 
    * @example
    * BA03159C-E808-4FF1-B27E-A61B6E888D7F
    */

package/src/models/ModifyInstanceRequest.ts

@@ -3,9 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyInstanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Description of the instance. The description can be up to 256 characters in length.
+   * 
+   * @example
+   * 新的实例描述。
+   */
   description?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyInstanceResponseBody.ts

@@ -4,18 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   * 
+   * @example
+   * 无
+   */
   data?: string;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 83TKE671A-3E24-4A04-81E6-6C4F5B39DF75
    */

package/src/models/ModifyPhoneNumberRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyPhoneNumberRequest extends $dara.Model {
   /**
+   * @remarks
+   * The IVR contact flow ID attached to the number. This field is valid only when the number usage is Inbound or Bidirection.
+   * 
    * @example
    * 78128960-bb00-4ddc-8a82-923a8c5bd22d
    */
   contactFlowId?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class ModifyPhoneNumberRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * Phone number.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,6 +33,8 @@ export class ModifyPhoneNumberRequest extends $dara.Model {
   number?: string;
   /**
    * @remarks
+   * Number usage.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyPhoneNumberResponseBody.ts

@@ -4,17 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyPhoneNumberResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
    */