@alicloud/dyvmsapi20170525 3.2.0 → 4.0.0

package/dist/client.d.ts

@@ -9,7 +9,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, endpoint: string): string;
     /**
-     * Adds the association relationship between a virtual number and real numbers in batches.
+     * Binds multiple real numbers to a service instance at a time.
      *
      * @remarks
      * ### QPS limits
@@ -21,7 +21,7 @@ export default class Client extends OpenApi {
      */
     addVirtualNumberRelationWithOptions(request: $_model.AddVirtualNumberRelationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AddVirtualNumberRelationResponse>;
     /**
-     * Adds the association relationship between a virtual number and real numbers in batches.
+     * Binds multiple real numbers to a service instance at a time.
      *
      * @remarks
      * ### QPS limits
@@ -32,7 +32,7 @@ export default class Client extends OpenApi {
      */
     addVirtualNumberRelation(request: $_model.AddVirtualNumberRelationRequest): Promise<$_model.AddVirtualNumberRelationResponse>;
     /**
-     * Initiates an outbound robocall task.
+     * Initiates outbound robocall tasks in a batch. You can set up to 100 numbers in a task.
      *
      * @remarks
      *   In an intelligent speech interaction task, you can use the robot communication scripts preset in the Voice Messaging Service console, or invoke the callback function to return the response mode configured by the business party in each call.
@@ -49,7 +49,7 @@ export default class Client extends OpenApi {
      */
     batchRobotSmartCallWithOptions(request: $_model.BatchRobotSmartCallRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchRobotSmartCallResponse>;
     /**
-     * Initiates an outbound robocall task.
+     * Initiates outbound robocall tasks in a batch. You can set up to 100 numbers in a task.
      *
      * @remarks
      *   In an intelligent speech interaction task, you can use the robot communication scripts preset in the Voice Messaging Service console, or invoke the callback function to return the response mode configured by the business party in each call.
@@ -65,12 +65,16 @@ export default class Client extends OpenApi {
      */
     batchRobotSmartCall(request: $_model.BatchRobotSmartCallRequest): Promise<$_model.BatchRobotSmartCallResponse>;
     /**
+     * Cancels the two-way call that is initiated by calling the ClickToDial operation.
+     *
      * @param request - CancelCallRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CancelCallResponse
      */
     cancelCallWithOptions(request: $_model.CancelCallRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelCallResponse>;
     /**
+     * Cancels the two-way call that is initiated by calling the ClickToDial operation.
+     *
      * @param request - CancelCallRequest
      * @returns CancelCallResponse
      */
@@ -139,7 +143,67 @@ export default class Client extends OpenApi {
      */
     changeMediaType(request: $_model.ChangeMediaTypeRequest): Promise<$_model.ChangeMediaTypeResponse>;
     /**
-     * Creates a task for sending voice notifications or voice verification codes.
+     * 新增任务
+     *
+     * @param request - CloudCreateTaskRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CloudCreateTaskResponse
+     */
+    cloudCreateTaskWithOptions(request: $_model.CloudCreateTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CloudCreateTaskResponse>;
+    /**
+     * 新增任务
+     *
+     * @param request - CloudCreateTaskRequest
+     * @returns CloudCreateTaskResponse
+     */
+    cloudCreateTask(request: $_model.CloudCreateTaskRequest): Promise<$_model.CloudCreateTaskResponse>;
+    /**
+     * 任务号码导入
+     *
+     * @param tmpReq - CloudImportTaskTelRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CloudImportTaskTelResponse
+     */
+    cloudImportTaskTelWithOptions(tmpReq: $_model.CloudImportTaskTelRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CloudImportTaskTelResponse>;
+    /**
+     * 任务号码导入
+     *
+     * @param request - CloudImportTaskTelRequest
+     * @returns CloudImportTaskTelResponse
+     */
+    cloudImportTaskTel(request: $_model.CloudImportTaskTelRequest): Promise<$_model.CloudImportTaskTelResponse>;
+    /**
+     * 任务启动
+     *
+     * @param request - CloudStartTaskRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CloudStartTaskResponse
+     */
+    cloudStartTaskWithOptions(request: $_model.CloudStartTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CloudStartTaskResponse>;
+    /**
+     * 任务启动
+     *
+     * @param request - CloudStartTaskRequest
+     * @returns CloudStartTaskResponse
+     */
+    cloudStartTask(request: $_model.CloudStartTaskRequest): Promise<$_model.CloudStartTaskResponse>;
+    /**
+     * 更新任务
+     *
+     * @param request - CloudUpdateTaskRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CloudUpdateTaskResponse
+     */
+    cloudUpdateTaskWithOptions(request: $_model.CloudUpdateTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CloudUpdateTaskResponse>;
+    /**
+     * 更新任务
+     *
+     * @param request - CloudUpdateTaskRequest
+     * @returns CloudUpdateTaskResponse
+     */
+    cloudUpdateTask(request: $_model.CloudUpdateTaskRequest): Promise<$_model.CloudUpdateTaskResponse>;
+    /**
+     * Uses a service instance to create a text-to-speech (TTS) task, a voice notification task, or a voice verification code task for multiple called numbers.
      *
      * @remarks
      * You can create up to 1,000 voice notifications for each task.
@@ -152,7 +216,7 @@ export default class Client extends OpenApi {
      */
     createCallTaskWithOptions(request: $_model.CreateCallTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCallTaskResponse>;
     /**
-     * Creates a task for sending voice notifications or voice verification codes.
+     * Uses a service instance to create a text-to-speech (TTS) task, a voice notification task, or a voice verification code task for multiple called numbers.
      *
      * @remarks
      * You can create up to 1,000 voice notifications for each task.
@@ -189,7 +253,7 @@ export default class Client extends OpenApi {
      */
     createRobotTask(request: $_model.CreateRobotTaskRequest): Promise<$_model.CreateRobotTaskResponse>;
     /**
-     * DegradeVideoFile
+     * Downgrades from a video call to a voice call.
      *
      * @param request - DegradeVideoFileRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -197,7 +261,7 @@ export default class Client extends OpenApi {
      */
     degradeVideoFileWithOptions(request: $_model.DegradeVideoFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DegradeVideoFileResponse>;
     /**
-     * DegradeVideoFile
+     * Downgrades from a video call to a voice call.
      *
      * @param request - DegradeVideoFileRequest
      * @returns DegradeVideoFileResponse
@@ -252,7 +316,7 @@ export default class Client extends OpenApi {
      */
     executeCallTask(request: $_model.ExecuteCallTaskRequest): Promise<$_model.ExecuteCallTaskResponse>;
     /**
-     * GetCallMediaType
+     * Obtains the call type during a call.
      *
      * @param request - GetCallMediaTypeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -260,7 +324,7 @@ export default class Client extends OpenApi {
      */
     getCallMediaTypeWithOptions(request: $_model.GetCallMediaTypeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCallMediaTypeResponse>;
     /**
-     * GetCallMediaType
+     * Obtains the call type during a call.
      *
      * @param request - GetCallMediaTypeRequest
      * @returns GetCallMediaTypeResponse
@@ -305,7 +369,7 @@ export default class Client extends OpenApi {
      */
     getHotlineQualificationByOrder(request: $_model.GetHotlineQualificationByOrderRequest): Promise<$_model.GetHotlineQualificationByOrderResponse>;
     /**
-     * GetTemporaryFileUrl
+     * Obtains a temporary URL of a video or audio file. You can view the video or audio file immediately by using this temporary URL.
      *
      * @param request - GetTemporaryFileUrlRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -313,7 +377,7 @@ export default class Client extends OpenApi {
      */
     getTemporaryFileUrlWithOptions(request: $_model.GetTemporaryFileUrlRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTemporaryFileUrlResponse>;
     /**
-     * GetTemporaryFileUrl
+     * Obtains a temporary URL of a video or audio file. You can view the video or audio file immediately by using this temporary URL.
      *
      * @param request - GetTemporaryFileUrlRequest
      * @returns GetTemporaryFileUrlResponse
@@ -387,7 +451,7 @@ export default class Client extends OpenApi {
      */
     ivrCall(request: $_model.IvrCallRequest): Promise<$_model.IvrCallResponse>;
     /**
-     * Queries task information.
+     * Queries the information about a voice call task after the task is created, including the task ID, task status, and templates used by the task.
      *
      * @remarks
      * ### QPS limits
@@ -399,7 +463,7 @@ export default class Client extends OpenApi {
      */
     listCallTaskWithOptions(request: $_model.ListCallTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCallTaskResponse>;
     /**
-     * Queries task information.
+     * Queries the information about a voice call task after the task is created, including the task ID, task status, and templates used by the task.
      *
      * @remarks
      * ### QPS limits
@@ -410,7 +474,7 @@ export default class Client extends OpenApi {
      */
     listCallTask(request: $_model.ListCallTaskRequest): Promise<$_model.ListCallTaskResponse>;
     /**
-     * Queries the information about a task based on the task ID.
+     * Queries the details of call tasks based on task IDs after call tasks are complete.
      *
      * @remarks
      * ### QPS limits
@@ -422,7 +486,7 @@ export default class Client extends OpenApi {
      */
     listCallTaskDetailWithOptions(request: $_model.ListCallTaskDetailRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCallTaskDetailResponse>;
     /**
-     * Queries the information about a task based on the task ID.
+     * Queries the details of call tasks based on task IDs after call tasks are complete.
      *
      * @remarks
      * ### QPS limits
@@ -471,7 +535,7 @@ export default class Client extends OpenApi {
      */
     listServiceInstanceForPage(request: $_model.ListServiceInstanceForPageRequest): Promise<$_model.ListServiceInstanceForPageResponse>;
     /**
-     * PauseVideoFile
+     * Pauses video playback when a video file is played back during a voice call.
      *
      * @param request - PauseVideoFileRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -479,14 +543,14 @@ export default class Client extends OpenApi {
      */
     pauseVideoFileWithOptions(request: $_model.PauseVideoFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PauseVideoFileResponse>;
     /**
-     * PauseVideoFile
+     * Pauses video playback when a video file is played back during a voice call.
      *
      * @param request - PauseVideoFileRequest
      * @returns PauseVideoFileResponse
      */
     pauseVideoFile(request: $_model.PauseVideoFileRequest): Promise<$_model.PauseVideoFileResponse>;
     /**
-     * PlayVideoFile
+     * Plays back a video file during a voice call.
      *
      * @param request - PlayVideoFileRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -494,7 +558,7 @@ export default class Client extends OpenApi {
      */
     playVideoFileWithOptions(request: $_model.PlayVideoFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PlayVideoFileResponse>;
     /**
-     * PlayVideoFile
+     * Plays back a video file during a voice call.
      *
      * @param request - PlayVideoFileRequest
      * @returns PlayVideoFileResponse
@@ -587,7 +651,7 @@ export default class Client extends OpenApi {
      */
     queryCallInTransferRecord(request: $_model.QueryCallInTransferRecordRequest): Promise<$_model.QueryCallInTransferRecordResponse>;
     /**
-     * Queries a list of robots.
+     * Queries a list of robots to obtain their details.
      *
      * @param request - QueryRobotInfoListRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -595,14 +659,14 @@ export default class Client extends OpenApi {
      */
     queryRobotInfoListWithOptions(request: $_model.QueryRobotInfoListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryRobotInfoListResponse>;
     /**
-     * Queries a list of robots.
+     * Queries a list of robots to obtain their details.
      *
      * @param request - QueryRobotInfoListRequest
      * @returns QueryRobotInfoListResponse
      */
     queryRobotInfoList(request: $_model.QueryRobotInfoListRequest): Promise<$_model.QueryRobotInfoListResponse>;
     /**
-     * Queries the call details of a called number in a robocall task.
+     * Queries the call details of a called number.
      *
      * @remarks
      * ### QPS limits
@@ -614,7 +678,7 @@ export default class Client extends OpenApi {
      */
     queryRobotTaskCallDetailWithOptions(request: $_model.QueryRobotTaskCallDetailRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryRobotTaskCallDetailResponse>;
     /**
-     * Queries the call details of a called number in a robocall task.
+     * Queries the call details of a called number.
      *
      * @remarks
      * ### QPS limits
@@ -717,7 +781,7 @@ export default class Client extends OpenApi {
      */
     queryRobotv2AllList(request: $_model.QueryRobotv2AllListRequest): Promise<$_model.QueryRobotv2AllListResponse>;
     /**
-     * QueryVideoPlayProgress
+     * Queries the video playback progress after you play a video file during a voice call.
      *
      * @param request - QueryVideoPlayProgressRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -725,37 +789,14 @@ export default class Client extends OpenApi {
      */
     queryVideoPlayProgressWithOptions(request: $_model.QueryVideoPlayProgressRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryVideoPlayProgressResponse>;
     /**
-     * QueryVideoPlayProgress
+     * Queries the video playback progress after you play a video file during a voice call.
      *
      * @param request - QueryVideoPlayProgressRequest
      * @returns QueryVideoPlayProgressResponse
      */
     queryVideoPlayProgress(request: $_model.QueryVideoPlayProgressRequest): Promise<$_model.QueryVideoPlayProgressResponse>;
     /**
-     * Queries a list of virtual numbers.
-     *
-     * @remarks
-     * ### QPS limits
-     * You can call this operation up to 100 times per second per account.
-     *
-     * @param request - QueryVirtualNumberRequest
-     * @param runtime - runtime options for this request RuntimeOptions
-     * @returns QueryVirtualNumberResponse
-     */
-    queryVirtualNumberWithOptions(request: $_model.QueryVirtualNumberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryVirtualNumberResponse>;
-    /**
-     * Queries a list of virtual numbers.
-     *
-     * @remarks
-     * ### QPS limits
-     * You can call this operation up to 100 times per second per account.
-     *
-     * @param request - QueryVirtualNumberRequest
-     * @returns QueryVirtualNumberResponse
-     */
-    queryVirtualNumber(request: $_model.QueryVirtualNumberRequest): Promise<$_model.QueryVirtualNumberResponse>;
-    /**
-     * Queries a list of associations between virtual numbers and real numbers.
+     * Lists real numbers bound to service instances. The returned data includes the binding time, the number activation time, and the number of real numbers bound to a service instance.
      *
      * @remarks
      * ### QPS limits
@@ -767,7 +808,7 @@ export default class Client extends OpenApi {
      */
     queryVirtualNumberRelationWithOptions(request: $_model.QueryVirtualNumberRelationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryVirtualNumberRelationResponse>;
     /**
-     * Queries a list of associations between virtual numbers and real numbers.
+     * Lists real numbers bound to service instances. The returned data includes the binding time, the number activation time, and the number of real numbers bound to a service instance.
      *
      * @remarks
      * ### QPS limits
@@ -838,7 +879,7 @@ export default class Client extends OpenApi {
      */
     recoverCallInConfig(request: $_model.RecoverCallInConfigRequest): Promise<$_model.RecoverCallInConfigResponse>;
     /**
-     * ResumeVideoFile
+     * Resumes video playback after you pause video playback during a voice call.
      *
      * @param request - ResumeVideoFileRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -846,7 +887,7 @@ export default class Client extends OpenApi {
      */
     resumeVideoFileWithOptions(request: $_model.ResumeVideoFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ResumeVideoFileResponse>;
     /**
-     * ResumeVideoFile
+     * Resumes video playback after you pause video playback during a voice call.
      *
      * @param request - ResumeVideoFileRequest
      * @returns ResumeVideoFileResponse
@@ -941,7 +982,7 @@ export default class Client extends OpenApi {
      */
     singleCallByTts(request: $_model.SingleCallByTtsRequest): Promise<$_model.SingleCallByTtsResponse>;
     /**
-     * 语音视频单呼接口
+     * Sends voice file notifications or video file notifications to a single called number.
      *
      * @param request - SingleCallByVideoRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -949,7 +990,7 @@ export default class Client extends OpenApi {
      */
     singleCallByVideoWithOptions(request: $_model.SingleCallByVideoRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SingleCallByVideoResponse>;
     /**
-     * 语音视频单呼接口
+     * Sends voice file notifications or video file notifications to a single called number.
      *
      * @param request - SingleCallByVideoRequest
      * @returns SingleCallByVideoResponse
@@ -983,7 +1024,7 @@ export default class Client extends OpenApi {
      */
     singleCallByVoice(request: $_model.SingleCallByVoiceRequest): Promise<$_model.SingleCallByVoiceResponse>;
     /**
-     * SkipVideoFile
+     * Fast forwards or rewinds a video when you play the video.
      *
      * @param request - SkipVideoFileRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -991,7 +1032,7 @@ export default class Client extends OpenApi {
      */
     skipVideoFileWithOptions(request: $_model.SkipVideoFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SkipVideoFileResponse>;
     /**
-     * SkipVideoFile
+     * Fast forwards or rewinds a video when you play the video.
      *
      * @param request - SkipVideoFileRequest
      * @returns SkipVideoFileResponse
@@ -1115,7 +1156,7 @@ export default class Client extends OpenApi {
      */
     stopRobotTask(request: $_model.StopRobotTaskRequest): Promise<$_model.StopRobotTaskResponse>;
     /**
-     * Submits a China 400 number for registration.
+     * Submits a 400 number for registration.
      *
      * @remarks
      * ### QPS limits
@@ -1127,7 +1168,7 @@ export default class Client extends OpenApi {
      */
     submitHotlineTransferRegisterWithOptions(request: $_model.SubmitHotlineTransferRegisterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SubmitHotlineTransferRegisterResponse>;
     /**
-     * Submits a China 400 number for registration.
+     * Submits a 400 number for registration.
      *
      * @remarks
      * ### QPS limits
@@ -1138,7 +1179,7 @@ export default class Client extends OpenApi {
      */
     submitHotlineTransferRegister(request: $_model.SubmitHotlineTransferRegisterRequest): Promise<$_model.SubmitHotlineTransferRegisterResponse>;
     /**
-     * UpgradeVideoFile
+     * Upgrades from a voice call to a video call.
      *
      * @param request - UpgradeVideoFileRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1146,7 +1187,7 @@ export default class Client extends OpenApi {
      */
     upgradeVideoFileWithOptions(request: $_model.UpgradeVideoFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpgradeVideoFileResponse>;
     /**
-     * UpgradeVideoFile
+     * Upgrades from a voice call to a video call.
      *
      * @param request - UpgradeVideoFileRequest
      * @returns UpgradeVideoFileResponse