@alicloud/ccc20200701 2.38.1 → 2.38.3

package/src/models/ListCallDetailRecordsRequest.ts

@@ -4,62 +4,97 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCallDetailRecordsRequest extends $dara.Model {
   /**
+   * @remarks
+   * Filter by agent ID.
+   * 
    * @example
    * agent@ccc-test
    */
   agentId?: string;
   /**
+   * @remarks
+   * Filter by called number.
+   * 
    * @example
    * 1320523****
    */
   calledNumber?: string;
   /**
+   * @remarks
+   * Filter by calling number.
+   * 
    * @example
    * 07353988****
    */
   callingNumber?: string;
   /**
+   * @remarks
+   * Filter by disposition type. Note: Disposition reasons such as voicemail, transfer to agent failed, queuing timeout, queuing overflow, and IVR abnormal are only displayed if the customer has configured a disposition reason node. If no such node is configured and there is no transfer-to-agent module in the IVR, the disposition reason defaults to "Abandoned in IVR".
+   * 
    * @example
    * Success
    */
   contactDisposition?: string;
   /**
+   * @remarks
+   * Filter by hang-up reason list.
+   * 
    * @example
    * ["Success","NoAnswer"]
    */
   contactDispositionList?: string;
   /**
+   * @remarks
+   * Query the record of a specific call by specifying a contactId. The contactId can be obtained from the softphone software development kit (SDK) during a call. If this parameter is provided, all other query parameters are automatically ignored.
+   * 
    * @example
    * job-12515239414412****
    */
   contactId?: string;
   /**
+   * @remarks
+   * Filter by call type.
+   * 
    * @example
    * Outbound
    */
   contactType?: string;
   /**
+   * @remarks
+   * Filter by contact type list.
+   * 
    * @example
    * ["Internal","Inbound"]
    */
   contactTypeList?: string;
   /**
+   * @remarks
+   * Perform a fuzzy query based on the calling or called number. The value must be a JSON string containing only one field, phoneNumber, which can be the full number or a partial segment of either the calling or called number.
+   * 
    * @example
    * {"phoneNumber":"0735"}
    */
   criteria?: string;
   /**
+   * @remarks
+   * Filter by a list of reasons for failed connection.
+   * 
    * @example
    * ["NotConnected","NoAnswer"]
    */
   earlyMediaStateList?: string;
   /**
+   * @remarks
+   * End time of the historical data to retrieve. The default value is the current time, in UNIX timestamp format with millisecond precision.
+   * 
    * @example
    * 1532707199000
    */
   endTime?: number;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -67,12 +102,17 @@ export class ListCallDetailRecordsRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Sorting field. Optional. Default value is startTime (call start time).
+   * 
    * @example
    * startTime
    */
   orderByField?: string;
   /**
    * @remarks
+   * Page number for paging, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -81,34 +121,58 @@ export class ListCallDetailRecordsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * Page size, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
    * 100
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * Filter by satisfaction description list. The description content is Custom by the Customer.
+   * 
+   * @example
+   * ["满意","一般"]
+   */
   satisfactionDescriptionList?: string;
   /**
+   * @remarks
+   * Filter by satisfaction List. Separate multiple satisfaction Results with commas.
+   * 
    * @example
    * ["1","3"]
    */
   satisfactionList?: string;
   /**
+   * @remarks
+   * Filter by satisfaction survey channel.
+   * 
    * @example
    * IVR
    */
   satisfactionSurveyChannel?: string;
   /**
+   * @remarks
+   * Filter by skill group ID.
+   * 
    * @example
    * skillgroup@ccc-test
    */
   skillGroupId?: string;
   /**
+   * @remarks
+   * Sorting order. This parameter is optional and defaults to descending.
+   * 
    * @example
    * DESC
    */
   sortOrder?: string;
   /**
+   * @remarks
+   * Start time of the historical data to retrieve. The default value is 00:00:00 of the current day, in UNIX timestamp format with millisecond precision.
+   * 
    * @example
    * 1532448000000
    */

package/src/models/ListCallDetailRecordsResponseBody.ts

@@ -4,136 +4,281 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCallDetailRecordsResponseBodyDataList extends $dara.Model {
   /**
+   * @remarks
+   * An additional broker number, which may be used in double-call scenarios.
+   * 
    * @example
    * 0533128****
    */
   additionalBroker?: string;
   /**
+   * @remarks
+   * A list of agent IDs, with multiple values separated by commas.
+   * 
    * @example
    * agent@ccc-test
    */
   agentIds?: string;
+  /**
+   * @remarks
+   * List of agent names involved in the call, separated by commas.
+   * 
+   * @example
+   * 坐席小王
+   */
   agentNames?: string;
   /**
+   * @remarks
+   * The intermediary number.
+   * 
    * @example
    * 0533127****
    */
   broker?: string;
   /**
+   * @remarks
+   * Call duration. For inbound calls, timing starts when the call enters IVR. For outbound calls, timing starts when the call is connected. The unit is seconds.
+   * 
    * @example
    * 30
    */
   callDuration?: string;
+  /**
+   * @remarks
+   * The Call-Id field in the underlying SIP protocol. If you need to obtain the call ID from the number provider side, you can retrieve it from this field.
+   * 
+   * @example
+   * EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
+   */
   callIds?: string;
   /**
+   * @remarks
+   * Called number.
+   * 
    * @example
    * 1332315****
    */
   calledNumber?: string;
+  /**
+   * @remarks
+   * The callee\\"s location.
+   * 
+   * @example
+   * 山东省-济南
+   */
   calleeLocation?: string;
+  /**
+   * @remarks
+   * Caller location.
+   * 
+   * @example
+   * 北京市-北京
+   */
   callerLocation?: string;
   /**
+   * @remarks
+   * Calling number.
+   * 
    * @example
    * 0533128****
    */
   callingNumber?: string;
   /**
+   * @remarks
+   * Reason for call termination.
+   * 
    * @example
    * Success
    */
   contactDisposition?: string;
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-12515239414412****
    */
   contactId?: string;
   /**
+   * @remarks
+   * Call type.
+   * 
    * @example
    * Outbound
    */
   contactType?: string;
+  /**
+   * @remarks
+   * Dial-up duration, in seconds.
+   * 
+   * @example
+   * 0
+   */
   dialingTime?: number;
   /**
+   * @remarks
+   * Reason for failure to connect.
+   * 
    * @example
    * NotConnected
    */
   earlyMediaState?: string;
   /**
+   * @remarks
+   * The time when the call was established. If the call was not established, this value is empty. The format is a Unix timestamp in milliseconds.
+   * 
    * @example
    * 1532448000000
    */
   establishedTime?: number;
+  /**
+   * @remarks
+   * The hold duration, in seconds.
+   * 
+   * @example
+   * 12
+   */
   heldTime?: number;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * IVR duration, in seconds. This is the time interval from when the IVR starts until the call enters the agent queue (or the customer hangs up).
+   * 
    * @example
    * 8
    */
   ivrTime?: number;
   /**
+   * @remarks
+   * The queue duration, in seconds, measured from when the customer entered the agent queue until the agent started ringing (or the customer abandoned the call, the queue timed out, or the queue overflowed).
+   * 
    * @example
    * 0
    */
   queueTime?: number;
   /**
+   * @remarks
+   * Recording duration, in seconds.
+   * 
    * @example
    * 10
    */
   recordingDuration?: number;
   /**
+   * @remarks
+   * Indicates whether the recording has been generated. Returns false if the call was not established.
+   * 
    * @example
    * true
    */
   recordingReady?: boolean;
   /**
+   * @remarks
+   * The party that ended the call.
+   * 
    * @example
    * customer
    */
   releaseInitiator?: string;
+  /**
+   * @remarks
+   * Hang-up reason for the channel, indicating why the current channel was disconnected. The value is derived from response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.
+   * 
+   * @example
+   * 486:USER_BUSY
+   */
   releaseReason?: string;
   /**
+   * @remarks
+   * The call end time, formatted as a Unix timestamp in milliseconds.
+   * 
    * @example
    * 1532707199000
    */
   releaseTime?: number;
   /**
+   * @remarks
+   * Ring duration, which is the time from when the agent\\"s phone starts ringing until the agent answers (or the customer hangs up), in seconds.
+   * 
    * @example
    * 5
    */
   ringTime?: number;
+  /**
+   * @remarks
+   * The satisfaction description, corresponding to the configuration of the satisfaction module in the satisfaction IVR. This is defined by the customer.
+   * 
+   * @example
+   * 满意
+   */
   satisfactionDescription?: string;
   /**
+   * @remarks
+   * Satisfaction rating, represented as a single-digit numeric value entered by the customer.
+   * 
    * @example
    * 1
    */
   satisfactionIndex?: number;
   /**
+   * @remarks
+   * The channel used for the satisfaction survey.
+   * 
    * @example
    * IVR
    */
   satisfactionSurveyChannel?: string;
   /**
+   * @remarks
+   * Indicates whether a satisfaction survey was initiated.
+   * 
    * @example
    * true
    */
   satisfactionSurveyOffered?: boolean;
   /**
+   * @remarks
+   * The IDs of the skill groups to which the agents participating in the call belong. Multiple skill group IDs are separated by commas.
+   * 
    * @example
    * skillgroup@ccc-test
    */
   skillGroupIds?: string;
+  /**
+   * @remarks
+   * The names of the skill groups to which the agents participating in the call belong. Multiple skill group names are separated by commas.
+   * 
+   * @example
+   * 测试技能组
+   */
   skillGroupNames?: string;
   /**
+   * @remarks
+   * Call start time. For inbound calls, timing starts when the call enters IVR. For outbound calls, timing starts from dial-up. The format is a Unix string in milliseconds.
+   * 
    * @example
    * 1532448000000
    */
   startTime?: number;
+  /**
+   * @remarks
+   * Talk time, in seconds.
+   * 
+   * @example
+   * 0
+   */
   talkTime?: number;
   /**
+   * @remarks
+   * The customer\\"s waiting duration, which equals QueueTime plus RingTime. If the customer abandons the call during waiting, the value is 0. The unit is seconds.
+   * 
    * @example
    * 5
    */
@@ -228,18 +373,31 @@ export class ListCallDetailRecordsResponseBodyDataList extends $dara.Model {
 }
 
 export class ListCallDetailRecordsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * List of call records.
+   */
   list?: ListCallDetailRecordsResponseBodyDataList[];
   /**
+   * @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. A real numeric value is returned only when PageNumber is 1; otherwise, 0 is returned.
+   * 
    * @example
    * 11
    */
@@ -276,18 +434,38 @@ export class ListCallDetailRecordsResponseBodyData extends $dara.Model {
 
 export class ListCallDetailRecordsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: ListCallDetailRecordsResponseBodyData;
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
    */