@alicloud/ccc20200701 2.38.2 → 2.39.0

package/src/models/ListAgentSummaryReportsSinceMidnightResponseBody.ts

@@ -4,81 +4,129 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportListInbound extends $dara.Model {
   /**
+   * @remarks
+   * Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.
+   * 
    * @example
    * 0
    */
   averageRingTime?: number;
   /**
+   * @remarks
+   * Average talk time, in seconds.
+   * 
    * @example
    * 0
    */
   averageTalkTime?: number;
   /**
+   * @remarks
+   * Average post-processing time, in seconds.
+   * 
    * @example
    * 0
    */
   averageWorkTime?: number;
   /**
+   * @remarks
+   * Acknowledgement Count, which is the number of times the agent answered calls.
+   * 
    * @example
    * 0
    */
   callsHandled?: number;
   /**
+   * @remarks
+   * Assign Count, which is the number of calls assigned to this agent, including calls blindly transferred or consultation-transferred from other agents.
+   * 
    * @example
    * 0
    */
   callsOffered?: number;
   /**
+   * @remarks
+   * Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assign events may fall into different Time Ranges, the Result may exceed 100% in certain cases).
+   * 
    * @example
    * 0
    */
   handleRate?: number;
   /**
+   * @remarks
+   * Maximum ring time, in seconds.
+   * 
    * @example
    * 0
    */
   maxRingTime?: number;
   /**
+   * @remarks
+   * Maximum talk time, in seconds.
+   * 
    * @example
    * 0
    */
   maxTalkTime?: number;
   /**
+   * @remarks
+   * Maximum post-processing time, in seconds.
+   * 
    * @example
    * 0
    */
   maxWorkTime?: number;
   /**
+   * @remarks
+   * Satisfaction Index, which is the average value of the single-digit satisfaction rating entered by customers.
+   * 
    * @example
    * 0
    */
   satisfactionIndex?: number;
   /**
+   * @remarks
+   * Sending Count of satisfaction surveys.
+   * 
    * @example
    * 0
    */
   satisfactionSurveysOffered?: number;
   /**
+   * @remarks
+   * Response Count of satisfaction surveys.
+   * 
    * @example
    * 0
    */
   satisfactionSurveysResponded?: number;
   /**
+   * @remarks
+   * Answer rate within 20 seconds, in percent (%).
+   * 
    * @example
    * 0
    */
   serviceLevel20?: number;
   /**
+   * @remarks
+   * Total ring time, in seconds.
+   * 
    * @example
    * 0
    */
   totalRingTime?: number;
   /**
+   * @remarks
+   * Total talk time, in seconds.
+   * 
    * @example
    * 0
    */
   totalTalkTime?: number;
   /**
+   * @remarks
+   * Total post-processing time, in seconds.
+   * 
    * @example
    * 0
    */
@@ -136,76 +184,121 @@ export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryRe
 
 export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportListOutbound extends $dara.Model {
   /**
+   * @remarks
+   * Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because management events for answering and acknowledgement may fall into different Time Ranges, the Result may exceed 100% in some cases.)
+   * 
    * @example
    * 0
    */
   answerRate?: number;
   /**
+   * @remarks
+   * Average dial-up time, in seconds.
+   * 
    * @example
    * 0
    */
   averageDialingTime?: number;
   /**
+   * @remarks
+   * Average talk time, in seconds.
+   * 
    * @example
    * 0
    */
   averageTalkTime?: number;
   /**
+   * @remarks
+   * Average post-processing duration, in seconds.
+   * 
    * @example
    * 0
    */
   averageWorkTime?: number;
   /**
+   * @remarks
+   * Number of answered calls.
+   * 
    * @example
    * 0
    */
   callsAnswered?: number;
   /**
+   * @remarks
+   * Number of dial-up calls.
+   * 
    * @example
    * 0
    */
   callsDialed?: number;
   /**
+   * @remarks
+   * Maximum dial-up duration, in seconds.
+   * 
    * @example
    * 0
    */
   maxDialingTime?: number;
   /**
+   * @remarks
+   * Maximum talk time, in seconds.
+   * 
    * @example
    * 0
    */
   maxTalkTime?: number;
   /**
+   * @remarks
+   * Maximum post-processing duration, in seconds.
+   * 
    * @example
    * 0
    */
   maxWorkTime?: string;
   /**
+   * @remarks
+   * Satisfaction index, which is the average value of the satisfaction rating digits (single-digit numbers).
+   * 
    * @example
    * 0
    */
   satisfactionIndex?: number;
   /**
+   * @remarks
+   * Sending Count of satisfaction surveys.
+   * 
    * @example
    * 0
    */
   satisfactionSurveysOffered?: number;
   /**
+   * @remarks
+   * Response Count of satisfaction surveys.
+   * 
    * @example
    * 0
    */
   satisfactionSurveysResponded?: number;
   /**
+   * @remarks
+   * Total dial-up time, in seconds.
+   * 
    * @example
    * 0
    */
   totalDialingTime?: number;
   /**
+   * @remarks
+   * Total talk time, in seconds.
+   * 
    * @example
    * 0
    */
   totalTalkTime?: number;
   /**
+   * @remarks
+   * Total post-processing time, in seconds.
+   * 
    * @example
    * 0
    */
@@ -261,86 +354,137 @@ export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryRe
 
 export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportListOverall extends $dara.Model {
   /**
+   * @remarks
+   * Average ready time. Calculation Formula: TotalReadyTime divided by the Count of ready events. The Count of ready events is a non-API statistical field, in seconds.
+   * 
    * @example
    * 0
    */
   averageReadyTime?: number;
   /**
+   * @remarks
+   * Average talk time. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled), in seconds.
+   * 
    * @example
    * 0
    */
   averageTalkTime?: number;
   /**
+   * @remarks
+   * Average post-processing time. Calculation Formula: TotalWorkTime divided by TotalCalls, in seconds.
+   * 
    * @example
    * 0
    */
   averageWorkTime?: number;
   /**
+   * @remarks
+   * Maximum ready time, in seconds.
+   * 
    * @example
    * 37
    */
   maxReadyTime?: number;
   /**
+   * @remarks
+   * Maximum talk time, in seconds.
+   * 
    * @example
    * 0
    */
   maxTalkTime?: number;
   /**
+   * @remarks
+   * Maximum post-processing time after a call, in seconds.
+   * 
    * @example
    * 0
    */
   maxWorkTime?: number;
   /**
+   * @remarks
+   * Agent occupancy rate. Calculation Formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.
+   * 
    * @example
    * 0
    */
   occupancyRate?: number;
   /**
+   * @remarks
+   * Quantity of directly transferred calls.
+   * 
    * @example
    * 0
    */
   oneTransferCalls?: number;
   /**
+   * @remarks
+   * Satisfaction index, which is the average of the satisfaction rating digits (single-digit numbers).
+   * 
    * @example
    * 0
    */
   satisfactionIndex?: number;
   /**
+   * @remarks
+   * Sending Count of satisfaction surveys.
+   * 
    * @example
    * 0
    */
   satisfactionSurveysOffered?: number;
   /**
+   * @remarks
+   * Count of satisfaction survey responses.
+   * 
    * @example
    * 0
    */
   satisfactionSurveysResponded?: number;
   /**
+   * @remarks
+   * Total break time, in seconds.
+   * 
    * @example
    * 0
    */
   totalBreakTime?: number;
   /**
+   * @remarks
+   * Total call volume. Calculation Formula: CallsOffered + CallsDialed.
+   * 
    * @example
    * 0
    */
   totalCalls?: number;
   /**
+   * @remarks
+   * Total logon time, excluding break time, in seconds.
+   * 
    * @example
    * 0
    */
   totalLoggedInTime?: number;
   /**
+   * @remarks
+   * Total ready time, in seconds.
+   * 
    * @example
    * 0
    */
   totalReadyTime?: number;
   /**
+   * @remarks
+   * Total talk time, in seconds.
+   * 
    * @example
    * 0
    */
   totalTalkTime?: number;
   /**
+   * @remarks
+   * Total post-processing time, in seconds.
+   * 
    * @example
    * 0
    */
@@ -400,31 +544,72 @@ export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryRe
 
 export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportList extends $dara.Model {
   /**
+   * @remarks
+   * Agent ID.
+   * 
    * @example
    * agent@ccc-test
    */
   agentId?: string;
+  /**
+   * @remarks
+   * Agent name.
+   * 
+   * @example
+   * 坐席小王。
+   */
   agentName?: string;
+  /**
+   * @remarks
+   * Inbound metrics.
+   */
   inbound?: ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportListInbound;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Agent logon name.
+   * 
    * @example
    * agent
    */
   loginName?: string;
+  /**
+   * @remarks
+   * Outbound metrics.
+   */
   outbound?: ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportListOutbound;
+  /**
+   * @remarks
+   * Overall metric.
+   */
   overall?: ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportListOverall;
   /**
+   * @remarks
+   * List of skill group IDs to which the agent belongs, formatted as a JSON array string, where each array element is a skill group ID.
+   * 
    * @example
    * ["skillgroup1@ccc-test","skillgroup2@ccc-test"]
    */
   skillGroupIds?: string;
+  /**
+   * @remarks
+   * List of skill group names to which the agent belongs, formatted as a JSON array string, where each array element is a skill group name.
+   * 
+   * @example
+   * ["测试技能组1","测试技能组2"]
+   */
   skillGroupNames?: string;
   /**
+   * @remarks
+   * The timestamp of the statistics data point.
+   * 
    * @example
    * 2018-09-13 00:00:00
    */
@@ -478,18 +663,31 @@ export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryRe
 }
 
 export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReport extends $dara.Model {
+  /**
+   * @remarks
+   * List of agent summary data.
+   */
   list?: ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReportList[];
   /**
+   * @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.
+   * 
    * @example
    * 2
    */
@@ -526,23 +724,46 @@ export class ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryRe
 
 export class ListAgentSummaryReportsSinceMidnightResponseBody 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
+   * Data.
+   */
   pagedAgentSummaryReport?: ListAgentSummaryReportsSinceMidnightResponseBodyPagedAgentSummaryReport;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 27DD30C4-CAE2-481A-97CC-D3C54625341D
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded.
+   * 
    * @example
    * true
    */

package/src/models/ListAttemptsRequest.ts

@@ -4,27 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAttemptsRequest extends $dara.Model {
   /**
+   * @remarks
+   * Filter by agent ID. This parameter is optional and defaults to empty.
+   * 
    * @example
    * agent@ccc-test
    */
   agentId?: string;
   /**
+   * @remarks
+   * Call record ID, which has the same value as the call ID.
+   * 
    * @example
    * job-16976964500325****
    */
   attemptId?: string;
   /**
+   * @remarks
+   * Filter by called number. Optional. Default is empty.
+   * 
    * @example
    * 1888888****
    */
   callee?: string;
   /**
+   * @remarks
+   * Filter by caller number. This parameter is optional and defaults to empty.
+   * 
    * @example
    * 05711234****
    */
   caller?: string;
   /**
    * @remarks
+   * Predictive outbound dialing Activity ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +47,8 @@ export class ListAttemptsRequest extends $dara.Model {
   campaignId?: string;
   /**
    * @remarks
+   * System-generated contact ID. Customers do not need to concern themselves with this value.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,18 +56,33 @@ export class ListAttemptsRequest extends $dara.Model {
    */
   caseId?: string;
   /**
+   * @remarks
+   * Filter by call ID. This parameter is optional and defaults to empty.
+   * 
    * @example
    * job-16976964500325****
    */
   contactId?: string;
+  /**
+   * @remarks
+   * Extended query conditions in JSON format. Currently supports caseIds for batch queries.
+   * 
+   * @example
+   * {"caseIds":["964f05a7-fc15-4a05-93a6-cd7421c4459e","5e2d508b-0df6-4077-8099-d3fff51ea6d0","da037029-8c83-4270-a90e-e7734be76af6"]}
+   */
   criteria?: string;
   /**
+   * @remarks
+   * End Time. This parameter is optional. If not specified, it defaults to the End Time of the predictive outbound dialing Activity. The format is a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1634115698291
    */
   endTime?: number;
   /**
    * @remarks
+   * Instance ID
+   * 
    * This parameter is required.
    * 
    * @example
@@ -60,6 +91,8 @@ export class ListAttemptsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * Page number. The product of PageNumber and PageSize must not exceed 10 000.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -68,6 +101,8 @@ export class ListAttemptsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * Page size. The product of PageNumber and PageSize must not exceed 10 000.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -75,11 +110,17 @@ export class ListAttemptsRequest extends $dara.Model {
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Filter by skill group ID. This parameter is optional and defaults to empty, which means no filtering is applied.
+   * 
    * @example
    * skillgroup@ccc-test
    */
   queueId?: string;
   /**
+   * @remarks
+   * Start Time. This parameter is optional. If not specified, it defaults to the Start Time of the predictive outbound dialing Activity. The format is a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1634115688291
    */