@alicloud/ccc20200701 2.38.1 → 2.38.3

package/src/models/ListCallSummariesRequest.ts

@@ -3,9 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListCallSummariesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * List of call IDs.
+   */
   contactIdList?: string[];
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListCallSummariesResponseBody.ts

@@ -4,27 +4,97 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCallSummariesResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Call ID.
+   * 
    * @example
    * job-544789******759424
    */
   contactId?: string;
+  /**
+   * @remarks
+   * Summary information.
+   * 
+   * @example
+   * {
+   *     "_sys_field_config": [
+   *         {
+   *             "Array": false,
+   *             "Required": true,
+   *             "DisplayName": "主题",
+   *             "Attributes": "{}",
+   *             "DataType": "TEXT",
+   *             "EditorType": "TEXT",
+   *             "MaxLength": 30,
+   *             "System": true,
+   *             "Name": "summaryTitle"
+   *         },
+   *         {
+   *             "Array": false,
+   *             "DisplayName": "小结",
+   *             "Attributes": "{}",
+   *             "DataType": "TEXT",
+   *             "EditorType": "TEXTAREA",
+   *             "MaxLength": 1000,
+   *             "System": true,
+   *             "Name": "summaryContent"
+   *         },
+   *         {
+   *             "Array": true,
+   *             "DisplayName": "标签",
+   *             "Attributes": "{}",
+   *             "DataType": "TEXT",
+   *             "EditorType": "SELECT",
+   *             "System": true,
+   *             "Name": "keywords"
+   *         }
+   *     ],
+   *     "summaryContent": "小结内容",
+   *     "creator": "creator@ccc-test",
+   *     "bizType": "Summary",
+   *     "keywords": [
+   *         "标签1"
+   *     ],
+   *     "source": "Console",
+   *     "summaryTitle": "测试会话小结",
+   *     "instanceId": "ccc-test",
+   *     "externalInput": "{\\"summaryTitle\\":\\"测试会话小结\\",\\"summaryContent\\":\\"小结内容\\",\\"keywords\\":[\\"标签1\\"],\\"_sys_field_config\\":[{\\"DisplayName\\":\\"主题\\",\\"Name\\":\\"summaryTitle\\",\\"Required\\":true,\\"EditorType\\":\\"TEXT\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":30,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"小结\\",\\"Name\\":\\"summaryContent\\",\\"EditorType\\":\\"TEXTAREA\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":1000,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"标签\\",\\"Name\\":\\"keywords\\",\\"EditorType\\":\\"SELECT\\",\\"Array\\":true,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"Attributes\\":\\"{}\\"}]}",
+   *     "templateName": "Summary-Ticket",
+   *     "bizId": "job-544789******759424",
+   *     "ticketStartTime": 1723449513735,
+   *     "ticketId": "ac0dd304-****-****-****-4a90010f0d38",
+   *     "definitionId": "Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6"
+   * }
+   */
   context?: string;
   /**
+   * @remarks
+   * Creation time.
+   * 
    * @example
    * 1723449513735
    */
   createdTime?: number;
   /**
+   * @remarks
+   * Creator.
+   * 
    * @example
    * creator@ccc-test
    */
   creator?: string;
   /**
+   * @remarks
+   * Editor.
+   * 
    * @example
    * editor@ccc-test
    */
   editor?: string;
   /**
+   * @remarks
+   * Summary ID.
+   * 
    * @example
    * ac0dd304-****-****-****-4a90010f0d38
    */
@@ -62,19 +132,43 @@ export class ListCallSummariesResponseBodyData extends $dara.Model {
 
 export class ListCallSummariesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Data.
+   */
   data?: ListCallSummariesResponseBodyData[];
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Error message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
+  /**
+   * @remarks
+   * List of error parameters.
+   */
   params?: string[];
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 932579BC-811A-503D-B322-4C2E57087CAA
    */

package/src/models/ListCallSummariesShrinkRequest.ts

@@ -3,9 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListCallSummariesShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * List of call IDs.
+   */
   contactIdListShrink?: string;
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListCallTagsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListCallTagsRequest extends $dara.Model {
   /**
    * @remarks
+   * Instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ListCallTagsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
+   * Paging ordinal number, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ListCallTagsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * The page size, ranging from 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListCallTagsResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCallTagsResponseBodyDataList extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * ccc-test
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The name of the number tag.
+   * 
    * @example
    * TagA
    */
@@ -37,18 +43,31 @@ export class ListCallTagsResponseBodyDataList extends $dara.Model {
 }
 
 export class ListCallTagsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of number tags.
+   */
   list?: ListCallTagsResponseBodyDataList[];
   /**
+   * @remarks
+   * The page number, ranging from 1 to 100.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size, ranging from 1 to 100.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total count.
+   * 
    * @example
    * 10
    */
@@ -85,18 +104,38 @@ export class ListCallTagsResponseBodyData extends $dara.Model {
 
 export class ListCallTagsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The data.
+   */
   data?: ListCallTagsResponseBodyData;
   /**
+   * @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/ListCampaignTrendingReportRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListCampaignTrendingReportRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the predictive outbound calling Activity.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class ListCampaignTrendingReportRequest extends $dara.Model {
    */
   campaignId?: string;
   /**
+   * @remarks
+   * The end time. This parameter is optional. The default value is the end time of the predictive outbound dialing activity.
+   * 
    * @example
    * 2021-10-14 20:59:59
    */
   endTime?: number;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,6 +32,9 @@ export class ListCampaignTrendingReportRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Start Time. This parameter is optional. The default value is the Start Time of the predictive outbound calling Activity.
+   * 
    * @example
    * 2021-10-14 00:00:00
    */

package/src/models/ListCampaignTrendingReportResponseBody.ts

@@ -4,47 +4,124 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCampaignTrendingReportResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Number of agents on break.
+   * 
    * @example
    * 0
    */
   breakAgents?: number;
+  /**
+   * @remarks
+   * Number of agents in break status.
+   * 
+   * @example
+   * 1
+   */
   breakingAgents?: number;
   /**
+   * @remarks
+   * The concurrent call volume, which refers to the number of simultaneous outbound calls.
+   * 
    * @example
    * 1
    */
   concurrency?: number;
   /**
+   * @remarks
+   * The timestamp for segmented statistics, formatted as a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1634037840000
    */
   datetime?: number;
   /**
+   * @remarks
+   * The number of published agents.
+   * 
    * @example
    * 2
    */
   loggedInAgents?: number;
+  /**
+   * @remarks
+   * The number of agents in outbound-only mode who are on a break.
+   * 
+   * @example
+   * 2
+   */
   outboundScenarioBreakingAgents?: number;
+  /**
+   * @remarks
+   * Number of agents in idle status under outbound-only mode.
+   * 
+   * @example
+   * 1
+   */
   outboundScenarioReadyAgents?: number;
+  /**
+   * @remarks
+   * The number of agents in outbound-only mode who are currently on a call.
+   * 
+   * @example
+   * 1
+   */
   outboundScenarioTalkingAgents?: number;
+  /**
+   * @remarks
+   * Number of agents in post-processing status under outbound-only mode.
+   * 
+   * @example
+   * 2
+   */
   outboundScenarioWorkingAgents?: number;
   /**
+   * @remarks
+   * Number of idle agents.
+   * 
    * @example
    * 2
    */
   readyAgents?: number;
+  /**
+   * @remarks
+   * Time of the statistical data point, formatted as a UNIX timestamp in milliseconds.
+   * 
+   * @example
+   * 1604639129000
+   */
   statsTime?: number;
   /**
+   * @remarks
+   * Deprecated. Refer to TalkAgents.
+   * 
    * @example
    * 0
    */
   talkAgents?: number;
+  /**
+   * @remarks
+   * The number of agents in a call.
+   * 
+   * @example
+   * 4
+   */
   talkingAgents?: number;
   /**
+   * @remarks
+   * Deprecated. Refer to WorkingAgents.
+   * 
    * @example
    * 0
    */
   workAgents?: number;
+  /**
+   * @remarks
+   * Number of agents in post-processing status.
+   * 
+   * @example
+   * 0
+   */
   workingAgents?: number;
   static names(): { [key: string]: string } {
     return {
@@ -97,18 +174,38 @@ export class ListCampaignTrendingReportResponseBodyData extends $dara.Model {
 
 export class ListCampaignTrendingReportResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * List of statistical data points.
+   */
   data?: ListCampaignTrendingReportResponseBodyData[];
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * Response message.
+   * 
+   * @example
+   * 无
+   */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0
    */

package/src/models/ListCampaignsRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCampaignsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The actual start time of the campaign. This parameter is optional. By default, all time ranges are queried.
+   * 
    * @example
-   * 2021-10-14 20:59:59
+   * 1780329600000
    */
   actualStartTimeFrom?: string;
   /**
+   * @remarks
+   * The actual end time of the campaign. This parameter is optional. By default, all time ranges are queried.
+   * 
    * @example
-   * 2021-10-14 20:59:59
+   * 1781625600000
    */
   actualStartTimeTo?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,12 +30,17 @@ export class ListCampaignsRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Filters campaigns by predictive dialing campaign name. Fuzzy match is not supported. This parameter is optional and defaults to empty, which indicates no filtering.
+   * 
    * @example
    * test-campaign
    */
   name?: string;
   /**
    * @remarks
+   * The page number. Valid values: 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -36,6 +49,8 @@ export class ListCampaignsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
+   * The page size. Valid values: 1 to 100.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -43,21 +58,33 @@ export class ListCampaignsRequest extends $dara.Model {
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The planned start time of the campaign. This parameter is optional. By default, all time ranges are queried.
+   * 
    * @example
-   * 2021-10-14 00:00:00
+   * 1780243200000
    */
   planedStartTimeFrom?: string;
   /**
+   * @remarks
+   * The planned end time of the campaign. This parameter is optional. By default, all time ranges are queried.
+   * 
    * @example
-   * 2021-10-14 20:59:59
+   * 1781798399000
    */
   planedStartTimeTo?: string;
   /**
+   * @remarks
+   * Filters campaigns by skill group ID. This parameter is optional and defaults to empty, which indicates no filtering.
+   * 
    * @example
    * skillgroup@ccc-test
    */
   queueId?: string;
   /**
+   * @remarks
+   * Filters campaigns by predictive dialing campaign state. This parameter is optional and defaults to empty.
+   * 
    * @example
    * Draft
    */