@alicloud/ccc20200701 2.38.2 → 2.39.0

package/src/models/PollUserStatusResponseBody.ts

@@ -4,76 +4,121 @@ import * as $dara from '@darabonba/typescript';
 
 export class PollUserStatusResponseBodyDataCallContextChannelContexts extends $dara.Model {
   /**
+   * @remarks
+   * The call type of the channel.
+   * 
    * @example
    * OUTBOUND
    */
   callType?: string;
   /**
+   * @remarks
+   * Call 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
    * CREATED
    */
   channelState?: string;
   /**
+   * @remarks
+   * Channel-associated data.
+   * 
    * @example
    * 123
    */
   channelVariables?: string;
   /**
+   * @remarks
+   * Callee of the call channel.
+   * 
    * @example
    * 1390501****
    */
   destination?: string;
   /**
+   * @remarks
+   * Auto-incremented system ID. Customers do not need to concern themselves with this value.
+   * 
    * @example
    * 1
    */
   index?: number;
   /**
+   * @remarks
+   * The call ID.
+   * 
    * @example
    * job-6538214103685****
    */
   jobId?: string;
   /**
+   * @remarks
+   * The calling party of the call channel.
+   * 
    * @example
    * 0830019****
    */
   originator?: string;
   /**
+   * @remarks
+   * The party that initiated the hang-up of the call channel, indicating who first terminated the call.
+   * 
    * @example
    * 1390501****
    */
   releaseInitiator?: string;
   /**
+   * @remarks
+   * The hang-up reason for the call channel, indicating why the current call channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.
+   * 
    * @example
    * 404 - No destination
    */
   releaseReason?: string;
   /**
+   * @remarks
+   * The skill group ID associated with the channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group the agent signed into.
+   * 
    * @example
    * skillgroup@ccc-test
    */
   skillGroupId?: string;
   /**
+   * @remarks
+   * The UNIX timestamp indicating the most recent status change of the channel, in milliseconds.
+   * 
    * @example
    * 1609138903315
    */
   timestamp?: number;
   /**
+   * @remarks
+   * The extension number of the agent associated with the voice channel.
+   * 
    * @example
    * 8032****
    */
   userExtension?: string;
   /**
+   * @remarks
+   * The agent ID associated with the voice channel. This field is empty if the channel belongs to a customer.
+   * 
    * @example
    * agent@ccc-test
    */
@@ -129,22 +174,38 @@ export class PollUserStatusResponseBodyDataCallContextChannelContexts extends $d
 
 export class PollUserStatusResponseBodyDataCallContext 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?: PollUserStatusResponseBodyDataCallContextChannelContexts[];
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-6538214103685****
    */
@@ -182,12 +243,77 @@ export class PollUserStatusResponseBodyDataCallContext extends $dara.Model {
 }
 
 export class PollUserStatusResponseBodyDataChatContextsMembers extends $dara.Model {
+  /**
+   * @remarks
+   * System auto increment ID. Customers do not need to concern themselves with this value.
+   * 
+   * @example
+   * 1
+   */
   index?: number;
+  /**
+   * @remarks
+   * The party that initiated the hang-up.
+   * 
+   * @example
+   * User
+   */
   releaseInitiator?: string;
+  /**
+   * @remarks
+   * The hang-up reason for the call channel, indicating why the current call channel was terminated. The value is derived from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol for analysis of the hang-up reason.
+   * 
+   * @example
+   * 无
+   */
   releaseReason?: string;
+  /**
+   * @remarks
+   * Skill group ID.
+   * 
+   * @example
+   * a527a80a-75cf-448f-aba0-fca37c61946d
+   */
   skillGroupId?: string;
+  /**
+   * @remarks
+   * The status of the agent in this session.
+   * 
+   * Enumeration values:
+   * 
+   * - RINGING
+   * 
+   * - TALKING
+   * 
+   * - RELEASED (End)
+   * 
+   * - MISSED (Missed)
+   * 
+   * @example
+   * RINGING
+   */
   status?: string;
+  /**
+   * @remarks
+   * Agent ID.
+   * 
+   * @example
+   * agent@ccc-test
+   */
   userId?: string;
+  /**
+   * @remarks
+   * User type.
+   * 
+   * Enumeration values:
+   * 
+   * - CUSTOMER: Customer
+   * 
+   * - AGENT: Agent
+   * 
+   * @example
+   * Manager
+   */
   userType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -223,10 +349,42 @@ export class PollUserStatusResponseBodyDataChatContextsMembers extends $dara.Mod
 }
 
 export class PollUserStatusResponseBodyDataChatContexts extends $dara.Model {
+  /**
+   * @remarks
+   * Ingest endpoint data.
+   * 
+   * @example
+   * 无
+   */
   callVariables?: string;
+  /**
+   * @remarks
+   * Session type.
+   * 
+   * @example
+   * INBOUND
+   */
   chatType?: string;
+  /**
+   * @remarks
+   * Instance ID.
+   * 
+   * @example
+   * ccc-test
+   */
   instanceId?: string;
+  /**
+   * @remarks
+   * Call job ID.
+   * 
+   * @example
+   * chat-65382141036853491
+   */
   jobId?: string;
+  /**
+   * @remarks
+   * Information about the agents and customers participating in this chat session.
+   */
   members?: PollUserStatusResponseBodyDataChatContextsMembers[];
   static names(): { [key: string]: string } {
     return {
@@ -261,8 +419,39 @@ export class PollUserStatusResponseBodyDataChatContexts extends $dara.Model {
 }
 
 export class PollUserStatusResponseBodyDataUserContextParallelJobList extends $dara.Model {
+  /**
+   * @remarks
+   * Session ID.
+   * 
+   * @example
+   * job-6538214103685****
+   */
   jobId?: string;
+  /**
+   * @remarks
+   * The agent\\"s status in this session.
+   * 
+   * ### Enumeration values:
+   * 
+   * - RINGING
+   * 
+   * - TALKING
+   * 
+   * - RELEASED (End)
+   * 
+   * - MISSED (Missed)
+   * 
+   * @example
+   * RINGING
+   */
   status?: string;
+  /**
+   * @remarks
+   * The time when the status changed.
+   * 
+   * @example
+   * 1609136956378
+   */
   timestamp?: number;
   static names(): { [key: string]: string } {
     return {
@@ -291,63 +480,107 @@ export class PollUserStatusResponseBodyDataUserContextParallelJobList extends $d
 
 export class PollUserStatusResponseBodyDataUserContext extends $dara.Model {
   /**
+   * @remarks
+   * Break status code, which can be either System-defined or Customer-defined. System-defined break codes include: Warm-up (temporary break state after an 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 Customer-defined status codes, and customers can define them according to their business needs.
+   * 
    * @example
    * Warm-up
    */
   breakCode?: string;
   /**
+   * @remarks
+   * Device ID, 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
    * 8032****
    */
   extension?: string;
   /**
+   * @remarks
+   * The time when the last heartbeat was received from the agent, in Unix timestamp format, in milliseconds.
+   * 
    * @example
    * 1609136956378
    */
   heartbeat?: number;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-6538214103685****
    */
   jobId?: string;
   /**
+   * @remarks
+   * The agent\\"s personal phone number.
+   * 
    * @example
    * 1324730****
    */
   mobile?: string;
   /**
+   * @remarks
+   * Indicates whether the agent is in outbound-only mode.
+   * 
    * @example
    * false
    */
   outboundScenario?: boolean;
+  /**
+   * @remarks
+   * Chat sessions currently being handled or already handled by the agent
+   */
   parallelJobList?: PollUserStatusResponseBodyDataUserContextParallelJobList[];
   /**
+   * @remarks
+   * The UNIX timestamp (in milliseconds) indicating when the agent was most recently reserved. Being reserved means an incoming call will soon be assigned to the agent.
+   * 
    * @example
    * 1609136956378
    */
   reserved?: number;
+  /**
+   * @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
    * BREAK
    */
   userState?: string;
   /**
+   * @remarks
+   * Work mode.
+   * 
    * @example
    * ON_SITE
    */
@@ -406,13 +639,28 @@ export class PollUserStatusResponseBodyDataUserContext extends $dara.Model {
 }
 
 export class PollUserStatusResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Call context environment.
+   */
   callContext?: PollUserStatusResponseBodyDataCallContext;
+  /**
+   * @remarks
+   * Session context environment.
+   */
   chatContexts?: PollUserStatusResponseBodyDataChatContexts[];
   /**
+   * @remarks
+   * System auto increment ID. Customers do not need to concern themselves with this.
+   * 
    * @example
    * 103655
    */
   contextId?: number;
+  /**
+   * @remarks
+   * Agent context environment.
+   */
   userContext?: PollUserStatusResponseBodyDataUserContext;
   static names(): { [key: string]: string } {
     return {
@@ -452,19 +700,43 @@ export class PollUserStatusResponseBodyData extends $dara.Model {
 
 export class PollUserStatusResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: PollUserStatusResponseBodyData;
   /**
+   * @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
    * EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
    */

package/src/models/ProcessCustomImcallbackRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ProcessCustomIMCallbackRequest extends $dara.Model {
   /**
    * @remarks
+   * The channel ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ProcessCustomIMCallbackRequest extends $dara.Model {
   accessChannelId?: string;
   /**
    * @remarks
+   * The session ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ProcessCustomIMCallbackRequest extends $dara.Model {
   conversationId?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,21 +35,50 @@ export class ProcessCustomIMCallbackRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * The message content.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 消息内容，格式如下：
+   * 
+   * 
+   * 文本消息：
+   * { "contentType":"Text", "text":"你好  " }
+   * 
+   * 图片消息：
+   * { "contentType":"Image", "mediaId": "xxx-xxx-xxx", "fileType": "png", "fileSize": 1233 }
+   * 
+   * 视频消息：
+   * { "contentType":"Video", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233, }
+   * 
+   * 音频消息：
+   * { "contentType":"Audio", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233 }
+   * 
+   * 文件消息：
+   * { "contentType":"File", "mediaId": "xxx-xxx-xxx", "fileSize": 223232, "filename": "xyz. zip" }
    */
   messageContent?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 03C67DAD-EB26-41D8-949D-9B0C470FB716
    */
   requestId?: string;
   /**
+   * @remarks
+   * The profile picture ID.
+   * 
    * @example
    * xxxx
    */
   senderAvatarMediaId?: string;
   /**
    * @remarks
+   * The user ID of the message sender.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -51,6 +86,9 @@ export class ProcessCustomIMCallbackRequest extends $dara.Model {
    */
   senderId?: string;
   /**
+   * @remarks
+   * The name of the sender.
+   * 
    * @example
    * tom
    */

package/src/models/ProcessCustomImcallbackResponseBody.ts

@@ -4,24 +4,54 @@ import * as $dara from '@darabonba/typescript';
 
 export class ProcessCustomIMCallbackResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The data.
+   * 
+   * @example
+   * 无
+   */
   data?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The job ID.
+   * 
    * @example
    * chat-65382141036853491
    */
   jobId?: string;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
+  /**
+   * @remarks
+   * The response parameters.
+   */
   params?: string[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 2778FA12-EDD6-42AA-9B15-AF855072E5E5
    */

package/src/models/PublishContactFlowRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class PublishContactFlowRequest extends $dara.Model {
   /**
    * @remarks
+   * The contact flow ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class PublishContactFlowRequest extends $dara.Model {
   contactFlowId?: string;
   /**
    * @remarks
+   * The draft ID. This is the ID of the draft version that corresponds to the current contact flow.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class PublishContactFlowRequest extends $dara.Model {
   draftId?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/PublishContactFlowResponseBody.ts

@@ -4,17 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class PublishContactFlowResponseBody 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
    * BFB6788F-20D4-5767-BC67-99EAAC28F789
    */