@alicloud/dyvmsapi20170525 2.3.1 → 3.0.0

package/src/models/QueryCallDetailByCallIdResponseBody.ts

@@ -0,0 +1,82 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryCallDetailByCallIdResponseBody 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 call, in the JSON format.
+   * 
+   * *   **caller**: the calling number.
+   * *   **startDate**: the time when the call was started.
+   * *   **stateDesc**: the description of the call state.
+   * *   **duration**: the call duration. Unit: seconds. The value **0** indicates that the user was not connected.
+   * *   **callerShowNumber**: the calling number displayed to the called party.
+   * *   **gmtCreate**: the time when the call request was received.
+   * *   **state**: the call state. The call state is returned by the Internet service provider (ISP) in real time. For more information about call states, see [ISP-returned error codes](https://help.aliyun.com/document_detail/55085.html).
+   * *   **endDate**: the time when the call was ended.
+   * *   **calleeShowNumber**: the number displayed to the called party.
+   * *   **callee**: the called number.
+   * *   **aRingTime**: the time when Line A started to ring, in the yyyy-MM-dd HH:mm:ss format.
+   * *   **aEndTime**: the time when ringing on Line A ended, in the yyyy-MM-dd HH:mm:ss format.
+   * *   **bRingTime**: the time when Line B started to ring, in the yyyy-MM-dd HH:mm:ss format.
+   * *   **bEndTime**: the time when ringing on Line B ended, in the yyyy-MM-dd HH:mm:ss format.
+   * 
+   * @example
+   * {"caller":"18767****","startDate":"","stateDesc":"502","duration":0,"callerShowNumber":"05344****","gmtCreate":"2017-11-27 20:09:06","state":"502","endDate":"","calleeShowNumber":"053447****","bRingTime":"2022-01-01 12:02:00"，"bEndTime":"2022-01-01 12:02:28"，"callee":"1373546****"}
+   */
+  data?: string;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * A90E4451-FED7-49D2-87C8-00700A8C4D0D
+   */
+  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/QueryCallDetailByTaskIdRequest.ts

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryCallDetailByTaskIdRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The called number. You can view the outbound call records of only one called number.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1390000****
+   */
+  callee?: string;
+  ownerId?: number;
+  /**
+   * @remarks
+   * The start time of the outbound robocall task. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2020-10-09 09:02:03
+   */
+  queryDate?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The unique ID of the outbound robocall task. The task ID is returned after the outbound robocall task is successfully delivered. You can view the task ID on the [Task Management](https://dyvms.console.aliyun.com/job/list) page of the Voice Messaging Service console, or call the **BatchRobotSmartCall** operation to obtain the **task ID**.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 4001112222
+   */
+  taskId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      callee: 'Callee',
+      ownerId: 'OwnerId',
+      queryDate: 'QueryDate',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      taskId: 'TaskId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      callee: 'string',
+      ownerId: 'number',
+      queryDate: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      taskId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryCallDetailByTaskIdResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { QueryCallDetailByTaskIdResponseBody } from "./QueryCallDetailByTaskIdResponseBody";
+
+
+export class QueryCallDetailByTaskIdResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: QueryCallDetailByTaskIdResponseBody;
+  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: QueryCallDetailByTaskIdResponseBody,
+    };
+  }
+
+  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/QueryCallDetailByTaskIdResponseBody.ts

@@ -0,0 +1,122 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryCallDetailByTaskIdResponseBody 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 call details of the outbound robocall task, in the JSON format.
+   * 
+   * *   **startDate**: the time when the call was answered.
+   * 
+   * *   **stateDesc**: the reason why the call was hung up. If the status code of early media was returned, this parameter indicates the reason why the status code of early media was used.
+   * 
+   * *   **statusCode**: the status code.
+   * 
+   * *   **EndDate**: the time when the call was ended.
+   * 
+   * *   **calleeShowNumber**: the calling number displayed to the called party.
+   * 
+   * *   **callee**: the called number.
+   * 
+   * *   **duration**: the billing duration.
+   * 
+   * *   **gmtCreate**: the time when the outbound robocall task was created.
+   * 
+   * *   **hangupDirection**: the party who hung up.
+   * 
+   * *   **tags**: the call tags.
+   * 
+   * *   **dialogCount**: the number of conversation rounds in 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.
+   * 
+   * *   **recordFile**: the download URL of the recording file. The URL is valid only for 48 hours. The recording file must be downloaded in time.
+   * 
+   * *   **callId**: the call ID.
+   * 
+   * *   **recordStatus**: indicates whether a recording file was available. Valid values:
+   * 
+   *     *   1: A recording file was available.
+   *     *   2: No recording file was available.
+   * 
+   * *   **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.
+   * 
+   * *   **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.
+   * 
+   * *   **callee**: the called number.
+   * 
+   * *   **dialogDetail**: the conversation details. The value is a JSON array that contains the following parameters:
+   * 
+   *     *   **role**: the role who spoke.
+   *     *   **content**: the content of the speech.
+   *     *   **time**: the start time of the speech.
+   * 
+   * > The preceding parameters are for reference only. The actually returned parameters prevail.
+   * 
+   * @example
+   * {"rejectCount":0,"dialogCount":3,"tags":"","startDate":"2019-03-27 10:34:54","gmtCreate":"2019-03-27 10:34:40","sureCount":0,"state":"200000","recordFile":"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_115987800002_02c3554f-ea24-422d-b1de-e671f455f21a_record.wav?OSSAccessKeyId=bypFNbGJVk73****&Signature=VWHOX%2FFhvvtSkxfMTw%2F5fdJUQuk%3D&Expires=1554382725","defaultCount":0,"endDate":"2019-03-27 10:35:09","calleeShowNumber":"1390000****","customCount":0,"callId":"1390000****","knowledgeCount":0,"recordStatus":1,"denyCount":0,"duration":16,"knowledgeCommonCount":0,"callee":"1390000****","knowledgeBusinessCount":0,"hangupDirection":1}
+   */
+  data?: string;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * D86B61A8-F2EE-4E4C-9F05-08A4676FFD89
+   */
+  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/QueryCallInPoolTransferConfigRequest.ts

@@ -0,0 +1,45 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryCallInPoolTransferConfigRequest extends $dara.Model {
+  ownerId?: number;
+  /**
+   * @remarks
+   * The China 400 number used to transfer the call.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 400****
+   */
+  phoneNumber?: string;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      ownerId: 'OwnerId',
+      phoneNumber: 'PhoneNumber',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ownerId: 'number',
+      phoneNumber: 'string',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryCallInPoolTransferConfigResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { QueryCallInPoolTransferConfigResponseBody } from "./QueryCallInPoolTransferConfigResponseBody";
+
+
+export class QueryCallInPoolTransferConfigResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: QueryCallInPoolTransferConfigResponseBody;
+  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: QueryCallInPoolTransferConfigResponseBody,
+    };
+  }
+
+  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/QueryCallInPoolTransferConfigResponseBody.ts

@@ -0,0 +1,160 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryCallInPoolTransferConfigResponseBodyDataDetails extends $dara.Model {
+  /**
+   * @remarks
+   * The number used to transfer the call.
+   * 
+   * @example
+   * 400****
+   */
+  called?: string;
+  static names(): { [key: string]: string } {
+    return {
+      called: 'Called',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      called: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class QueryCallInPoolTransferConfigResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The call mode. Valid values:
+   * 
+   * *   **roundRobin**
+   * *   **random**
+   * 
+   * @example
+   * random
+   */
+  calledRouteMode?: string;
+  /**
+   * @remarks
+   * The details of the response parameters.
+   */
+  details?: QueryCallInPoolTransferConfigResponseBodyDataDetails[];
+  /**
+   * @remarks
+   * The time when the call transfer task was created.
+   * 
+   * @example
+   * 1623137002000
+   */
+  gmtCreate?: number;
+  /**
+   * @remarks
+   * The timeout period for transferring the call.
+   * 
+   * @example
+   * 30
+   */
+  transferTimeout?: string;
+  static names(): { [key: string]: string } {
+    return {
+      calledRouteMode: 'CalledRouteMode',
+      details: 'Details',
+      gmtCreate: 'GmtCreate',
+      transferTimeout: 'TransferTimeout',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      calledRouteMode: 'string',
+      details: { 'type': 'array', 'itemType': QueryCallInPoolTransferConfigResponseBodyDataDetails },
+      gmtCreate: 'number',
+      transferTimeout: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.details)) {
+      $dara.Model.validateArray(this.details);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class QueryCallInPoolTransferConfigResponseBody 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 response parameters.
+   */
+  data?: QueryCallInPoolTransferConfigResponseBodyData;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 7BF47617-7851-48F7-A3A1-2021342A78E2
+   */
+  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: QueryCallInPoolTransferConfigResponseBodyData,
+      message: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryCallInTransferRecordRequest.ts

@@ -0,0 +1,93 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryCallInTransferRecordRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The calling number of the inbound call.
+   * 
+   * @example
+   * 150****0000
+   */
+  callInCaller?: string;
+  ownerId?: number;
+  /**
+   * @remarks
+   * The page number. Default value: **1**.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1
+   */
+  pageNo?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values: 1 to 10.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 10
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The phone number to which a call is transferred.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 400****
+   */
+  phoneNumber?: string;
+  /**
+   * @remarks
+   * The time at which call transfer records are queried, in the YYYY-MM-DD hh:mm:ss format.
+   * 
+   * > The query result is all the call transfer records of the specified day.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2021-06-28 00:00:00
+   */
+  queryDate?: string;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      callInCaller: 'CallInCaller',
+      ownerId: 'OwnerId',
+      pageNo: 'PageNo',
+      pageSize: 'PageSize',
+      phoneNumber: 'PhoneNumber',
+      queryDate: 'QueryDate',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      callInCaller: 'string',
+      ownerId: 'number',
+      pageNo: 'number',
+      pageSize: 'number',
+      phoneNumber: 'string',
+      queryDate: 'string',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryCallInTransferRecordResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { QueryCallInTransferRecordResponseBody } from "./QueryCallInTransferRecordResponseBody";
+
+
+export class QueryCallInTransferRecordResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: QueryCallInTransferRecordResponseBody;
+  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: QueryCallInTransferRecordResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+