@alicloud/dyvmsapi20170525 2.3.2 → 3.0.0

package/src/models/QueryRobotTaskCallListRequest.ts

@@ -0,0 +1,144 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryRobotTaskCallListRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The call result. Valid values:
+   * 
+   * *   **200002**: The line is busy.
+   * *   **200005**: The called party cannot be connected.
+   * *   **200010**: The phone of the called party is powered off.
+   * *   **200011**: The called party is out of service.
+   * *   **200012**: The call is lost.
+   * 
+   * @example
+   * 200002
+   */
+  callResult?: string;
+  /**
+   * @remarks
+   * The called number.
+   * 
+   * @example
+   * 1300****0000
+   */
+  called?: string;
+  /**
+   * @remarks
+   * The minimum number of conversation rounds in the call.
+   * 
+   * @example
+   * 0
+   */
+  dialogCountFrom?: string;
+  /**
+   * @remarks
+   * The maximum number of conversation rounds in the call.
+   * 
+   * @example
+   * 5
+   */
+  dialogCountTo?: string;
+  /**
+   * @remarks
+   * The minimum call duration.
+   * 
+   * @example
+   * 0
+   */
+  durationFrom?: string;
+  /**
+   * @remarks
+   * The maximum call duration.
+   * 
+   * @example
+   * 60
+   */
+  durationTo?: string;
+  /**
+   * @remarks
+   * The party who hangs up. Valid values:
+   * 
+   * *   **0**: the called party.
+   * *   **1**: the robot.
+   * 
+   * @example
+   * 1
+   */
+  hangupDirection?: string;
+  ownerId?: number;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNo?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The unique ID of the robocall task. You can call the [CreateRobotTask](https://help.aliyun.com/document_detail/393531.html) operation to obtain the task ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1045001****
+   */
+  taskId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      callResult: 'CallResult',
+      called: 'Called',
+      dialogCountFrom: 'DialogCountFrom',
+      dialogCountTo: 'DialogCountTo',
+      durationFrom: 'DurationFrom',
+      durationTo: 'DurationTo',
+      hangupDirection: 'HangupDirection',
+      ownerId: 'OwnerId',
+      pageNo: 'PageNo',
+      pageSize: 'PageSize',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      taskId: 'TaskId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      callResult: 'string',
+      called: 'string',
+      dialogCountFrom: 'string',
+      dialogCountTo: 'string',
+      durationFrom: 'string',
+      durationTo: 'string',
+      hangupDirection: 'string',
+      ownerId: 'number',
+      pageNo: 'number',
+      pageSize: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      taskId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskCallListResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { QueryRobotTaskCallListResponseBody } from "./QueryRobotTaskCallListResponseBody";
+
+
+export class QueryRobotTaskCallListResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: QueryRobotTaskCallListResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: QueryRobotTaskCallListResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskCallListResponseBody.ts

@@ -0,0 +1,92 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryRobotTaskCallListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response code.
+   * 
+   * *   The value OK indicates that the request was successful.
+   * *   For more information about other response codes, see [API error codes](https://help.aliyun.com/document_detail/112502.html).
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The information about the robocall task, which is a JSON-formatted array.
+   * 
+   * *   **taskId**: the unique ID of the robocall task.
+   * *   **caller**: the calling number.
+   * *   **called**: the called number.
+   * *   **duration**: the call duration. Unit: seconds.
+   * *   **label**: the label of the called party.
+   * *   **dialogCount**: the number of conversation rounds in the call.
+   * *   **callResult**: the call result.
+   * *   **hangupDirection**: the party who hung up. Valid values: **1** and **0**. The value 1 indicates the called party, and the value 0 indicates the robot.
+   * *   **transferResult**: the result of transferring the call to an agent. Valid values: **1**, **0**, and **3**. The value 1 indicates that the call was transferred to an agent. The value 0 indicates that the call failed to be transferred to an agent. The value 3 indicates that the call was not transferred to an agent.
+   * *   **transferNumber**: the phone number of the agent to whom the call was transferred.
+   * *   **transferFailReason**: the reason why the call failed to be transferred to an agent.
+   * *   **callId**: the unique receipt ID of the call.
+   * *   **recallCurTimes**: the number of recalls.
+   * *   **callStartTime**: the start time of the call.
+   * *   **callEndTime**: the end time of the call.
+   * *   **sureCount**: the number of times that the robocall task was acknowledged.
+   * *   **denyCount**: the number of times that the robocall task was denied.
+   * *   **rejectCount**: the number of times that the robocall task was rejected.
+   * *   **customCount**: the number of times that the robocall task was customized.
+   * *   **knowledgeCount**: the number of times that the knowledge base was queried.
+   * *   **defaultCount**: the default number of calls.
+   * *   **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.
+   * *   **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.
+   * *   ****
+   * 
+   * @example
+   * [ {"taskId":"1045001", "caller":"0571-889****", "called": "130****0000", "duration":"60", "label":"Invitation", "dialogCount":"3", "callResult":"Not Available", "hangupDirection":"1", "transferResult":"3", "transferNumber":"0571-8833****", "transferFailReason":"User hangs up", "callId":"116950320375^10375010****", "recallCurTimes":"2", "callStartTime":"2019.06.14 15:22:23", "callEndTime":"2019.06.14 15:22:55", "sureCount":"2", "denyCount":"2", "rejectCount":"0", "customCount:"0", "knowledgeCount":"0", "defaultCount":"0", "knowledgeBusinessCount":"0", "knowledgeCommonCount":"0"} ]
+   */
+  data?: string;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'string',
+      message: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskDetailRequest.ts

@@ -0,0 +1,45 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryRobotTaskDetailRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1045001
+   */
+  id?: number;
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      id: 'Id',
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      id: 'number',
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskDetailResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { QueryRobotTaskDetailResponseBody } from "./QueryRobotTaskDetailResponseBody";
+
+
+export class QueryRobotTaskDetailResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: QueryRobotTaskDetailResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: QueryRobotTaskDetailResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskDetailResponseBody.ts

@@ -0,0 +1,86 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryRobotTaskDetailResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response code.
+   * 
+   * *   The value OK indicates that the request was successful.
+   * *   For more information about other response codes, see [API error codes](https://help.aliyun.com/document_detail/112502.html).
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The details of the robocall task, in the JSON format.
+   * 
+   * *   **Id**: the unique ID of the robocall task.
+   * *   **taskName**: the task name.
+   * *   **robotId**: the robot ID.
+   * *   **robotName**: the robot name.
+   * *   **corpName**: the company name.
+   * *   **caller**: the number displayed to the called party.
+   * *   **numberStatusIdent**: indicates whether number status identification was enabled. Valid values: **true** and **false**. The value true indicates that number status identification was enabled. The value false indicates that number status identification was not enabled.
+   * *   **status**: the task state. You can call the [QueryRobotTaskList](~~QueryRobotTaskList~~) operation to obtain the task state from the `status` parameter.
+   * *   **scheduleType**: the scheduling type. Valid values: **SINGLE** and **ORDER**. The value SINGLE indicates that the task was started immediately after it was created. The value ORDER indicates that the task was started at a scheduled time.
+   * *   **retryType**: indicates whether auto-redial was enabled. Valid values: **1** and **0**. The value 1 indicates that auto-redial was enabled. The value 0 indicates that auto-redial was not enabled.
+   * *   **recallStateCodes**: the call state in which redial is required. Valid values: **200010**, **200011**, **200002**, **200012**, and **200005**. The value 200010 indicates that the phone of the called party was powered off. The value 200011 indicates that the number of the called party was out of service. The value 200002 indicates that the line was busy. The value 200012 indicates that the call was lost. The value 200005 indicates that the called party could not be connected.
+   * *   **recallTimes**: the number of redial times.
+   * *   **recallInterval**: the redial interval. Unit: minutes.
+   * *   **createTime**: the time when the task was created, in the yyyy-MM-dd HH:mm:ss format.
+   * *   **fireTime**: the time when the task was started, in the yyyy-MM-dd HH:mm:ss format.
+   * *   **completeTime**: the time when the task was completed, in the yyyy-MM-dd HH:mm:ss format.
+   * *   **filename**: the name of the called number file.
+   * *   **ossFilePath**: the path of the called number file.
+   * 
+   * @example
+   * {"id":1045001,"taskName":"Test Template","robotId":1000000075003,"robotName":"robot","corpName":"company ","caller":"057156xxxx,0571568xxxx", "numberStatusIdent":true,"status":"INIT","scheduleType":"SINGLE", "retryType":1,"recallStateCodes":"200010,200011", "recallTimes":2,"recallInterval":5,"createTime": "2019-06-14 11:04:19","fireTime":"2019-06-14 11:05:23","completeTime": "2019-06-14 18:21:06","called": [{"fileName": "5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi", "ossFilePath": "http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx"}]}
+   */
+  data?: string;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'string',
+      message: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskListRequest.ts

@@ -0,0 +1,94 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryRobotTaskListRequest extends $dara.Model {
+  ownerId?: number;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNo?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The task state. Valid values:
+   * 
+   * *   **INIT**: The task is not started.
+   * *   **READY**: The task is ready to start.
+   * *   **DISPATCH**: The task is being parsed.
+   * *   **EXCUTING**: The task is being executed.
+   * *   **MANUAL_STOP**: The task is manually suspended.
+   * *   **SYSTEM_STOP**: The task is suspended by the system.
+   * *   **ARREARS_STOP**: The task is suspended due to overdue payments.
+   * *   **CANCEL**: The task is manually canceled.
+   * *   **SYSTEM_CANCEL**: The task is canceled by the system.
+   * *   **FINISH**: The task is complete.
+   * 
+   * @example
+   * EXCUTING
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The task name.
+   * 
+   * @example
+   * Test Template
+   */
+  taskName?: string;
+  /**
+   * @remarks
+   * The date when the task is created, in the yyyy-MM-dd format.
+   * 
+   * @example
+   * 2019-06-14
+   */
+  time?: string;
+  static names(): { [key: string]: string } {
+    return {
+      ownerId: 'OwnerId',
+      pageNo: 'PageNo',
+      pageSize: 'PageSize',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      status: 'Status',
+      taskName: 'TaskName',
+      time: 'Time',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ownerId: 'number',
+      pageNo: 'number',
+      pageSize: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      status: 'string',
+      taskName: 'string',
+      time: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskListResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { QueryRobotTaskListResponseBody } from "./QueryRobotTaskListResponseBody";
+
+
+export class QueryRobotTaskListResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: QueryRobotTaskListResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: QueryRobotTaskListResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryRobotTaskListResponseBody.ts

@@ -0,0 +1,106 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryRobotTaskListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response code.
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The robocall tasks, in the JSON format.
+   * 
+   * *   **id**: the unique ID of the robocall task.
+   * *   **taskName**: the task name.
+   * *   **robotId**: the robot ID.
+   * *   **robotName**: the robot name.
+   * *   **status**: the task state.
+   * *   **scheduleType**: the scheduling type. Valid values: **SINGLE** and **ORDER**. The value SINGLE indicates that the task was started immediately after it was created. The value ORDER indicates that the task was started at a scheduled time.
+   * *   **createTime**: the time when the task was created, in the yyyy.MM.dd HH:mm:ss format.
+   * *   **completeTime**: the time when the task was completed, in the yyyy.MM.dd HH:mm:ss format.
+   * *   **fireTime**: the time when the task was started, in the yyyy.MM.dd HH:mm:ss format.
+   * *   **totalCount**: the total number of calls processed.
+   * *   **finishCount**: the number of calls completed.
+   * 
+   * @example
+   * [ {"id": 1045001, "taskName": "Test Template", "robotId": 1000000075003, "robotName": "robot", "status": "INIT","scheduleType": "SINGLE", "createTime": "2019.06.14 14:55:23", "completeTime": "2019.06.14 14:55:23", "fireTime": "2019.06.14 14:55:23", "totalCount": 1000, "finishCount": 998} ]
+   */
+  data?: string;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNo?: string;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 1
+   */
+  pageSize?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of tasks.
+   * 
+   * @example
+   * 1
+   */
+  totalCount?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      pageNo: 'PageNo',
+      pageSize: 'PageSize',
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'string',
+      message: 'string',
+      pageNo: 'string',
+      pageSize: 'string',
+      requestId: 'string',
+      totalCount: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+