@alicloud/dyvmsapi20170525 2.3.2 → 3.1.0

package/src/models/CreateRobotTaskRequest.ts

@@ -0,0 +1,169 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateRobotTaskRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The calling number.
+   * 
+   * You must use the phone numbers that you have purchased and separate multiple numbers with commas (,). You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home) and choose **Real Number Service** > **Real Number Management** to view the numbers you purchased.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 0571****5678
+   */
+  caller?: string;
+  /**
+   * @remarks
+   * The company name, which must be the same as the **enterprise name** on the qualification management page.
+   * 
+   * @example
+   * Alibaba
+   */
+  corpName?: string;
+  /**
+   * @remarks
+   * The ID of the robot or communication script that is used to initiate the call.
+   * 
+   * You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home) and choose **Intelligent Voice Robot** > **Communication Script Management** to view the communication script ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1000023****
+   */
+  dialogId?: number;
+  /**
+   * @remarks
+   * Specifies whether to call the self-managed line. Valid values:
+   * 
+   * *   **false** (default)
+   * *   **true**
+   * 
+   * > If you set this parameter to **true**, calling numbers are not verified.
+   * 
+   * @example
+   * false
+   */
+  isSelfLine?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to enable number status identification. Valid values:
+   * 
+   * *   **false** (default)
+   * *   **true**
+   * 
+   * > If you set this parameter to **true**, the reason why a call is not answered is recorded.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * true
+   */
+  numberStatusIdent?: boolean;
+  ownerId?: number;
+  /**
+   * @remarks
+   * The redial interval. Unit: minutes. The value must be greater than 1.
+   * 
+   * > The maximum redial interval is 30 minutes.
+   * 
+   * @example
+   * 5
+   */
+  recallInterval?: number;
+  /**
+   * @remarks
+   * The call state in which redial is required. Separate multiple call states with commas (,). Valid values:
+   * 
+   * *   **200010**: The phone of the called party is powered off.
+   * *   **200011**: The number of the called party is out of service.
+   * *   **200002**: The line is busy.
+   * *   **200012**: The call is lost.
+   * *   **200005**: The called party cannot be connected.
+   * *   **200003**: The called party does not respond to the call.
+   * 
+   * @example
+   * 200010,200011
+   */
+  recallStateCodes?: string;
+  /**
+   * @remarks
+   * The number of redial times.
+   * 
+   * @example
+   * 1
+   */
+  recallTimes?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * Specifies whether to enable auto-redial. Valid values:
+   * 
+   * *   **1**: enables auto-redial.
+   * *   **0**: disables auto-redial.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1
+   */
+  retryType?: number;
+  /**
+   * @remarks
+   * The task name. The task name can be up to 30 characters in length.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Test Template
+   */
+  taskName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      caller: 'Caller',
+      corpName: 'CorpName',
+      dialogId: 'DialogId',
+      isSelfLine: 'IsSelfLine',
+      numberStatusIdent: 'NumberStatusIdent',
+      ownerId: 'OwnerId',
+      recallInterval: 'RecallInterval',
+      recallStateCodes: 'RecallStateCodes',
+      recallTimes: 'RecallTimes',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      retryType: 'RetryType',
+      taskName: 'TaskName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      caller: 'string',
+      corpName: 'string',
+      dialogId: 'number',
+      isSelfLine: 'boolean',
+      numberStatusIdent: 'boolean',
+      ownerId: 'number',
+      recallInterval: 'number',
+      recallStateCodes: 'string',
+      recallTimes: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      retryType: 'number',
+      taskName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateRobotTaskResponse.ts

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

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateRobotTaskResponseBody 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 unique ID of the robocall task.
+   * 
+   * You can call the [QueryRobotTaskDetail](https://help.aliyun.com/document_detail/393538.html) operation to query the details of the task based on the task ID.
+   * 
+   * @example
+   * 400111****
+   */
+  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/DegradeVideoFileRequest.ts

@@ -0,0 +1,64 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DegradeVideoFileRequest extends $dara.Model {
+  /**
+   * @example
+   * 116012354148^1028137841****
+   */
+  callId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 1590****000
+   */
+  calledNumber?: string;
+  /**
+   * @example
+   * video
+   */
+  mediaType?: string;
+  /**
+   * @example
+   * 225869*****
+   */
+  outId?: string;
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      callId: 'CallId',
+      calledNumber: 'CalledNumber',
+      mediaType: 'MediaType',
+      outId: 'OutId',
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      callId: 'string',
+      calledNumber: 'string',
+      mediaType: 'string',
+      outId: 'string',
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DegradeVideoFileResponse.ts

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

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DegradeVideoFileResponseBody extends $dara.Model {
+  accessDeniedDetail?: string;
+  /**
+   * @example
+   * OK
+   */
+  code?: string;
+  data?: { [key: string]: any };
+  /**
+   * @example
+   * 示例值
+   */
+  message?: string;
+  /**
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      accessDeniedDetail: 'AccessDeniedDetail',
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accessDeniedDetail: 'string',
+      code: 'string',
+      data: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
+      message: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data) {
+      $dara.Model.validateMap(this.data);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteRobotTaskRequest.ts

@@ -0,0 +1,45 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteRobotTaskRequest extends $dara.Model {
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @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
+   */
+  taskId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      taskId: 'TaskId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      taskId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteRobotTaskResponse.ts

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

@@ -0,0 +1,70 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteRobotTaskResponseBody 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
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   **true**: The request was successful.
+   * *   **false**: The request failed.
+   * 
+   * @example
+   * true
+   */
+  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/ExecuteCallTaskRequest.ts

@@ -0,0 +1,73 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ExecuteCallTaskRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The time when the call task is executed, in the yyyy-MM-dd HH:mm:ss format.
+   * 
+   * > You can leave this parameter empty.
+   * 
+   * @example
+   * 2021-03-09 00:00:00
+   */
+  fireTime?: string;
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The task state. Valid values:
+   * 
+   * *   **RUNNING**
+   * *   **STOP**
+   * *   **CANCEL**
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * RUNNING
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The task ID. You can call the [CreateCallTask](~~CreateCallTask~~) operation to obtain the task ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2256****
+   */
+  taskId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      fireTime: 'FireTime',
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      status: 'Status',
+      taskId: 'TaskId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fireTime: 'string',
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      status: 'string',
+      taskId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ExecuteCallTaskResponse.ts

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