From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/dyvmsapi/2017-05-25/api-docs.php | 19438 ++++++++++++++++++-------- 1 file changed, 13438 insertions(+), 6000 deletions(-) (limited to 'data/en_us/dyvmsapi/2017-05-25/api-docs.php') diff --git a/data/en_us/dyvmsapi/2017-05-25/api-docs.php b/data/en_us/dyvmsapi/2017-05-25/api-docs.php index 4d23dc6..c3639c4 100644 --- a/data/en_us/dyvmsapi/2017-05-25/api-docs.php +++ b/data/en_us/dyvmsapi/2017-05-25/api-docs.php @@ -1,175 +1,88 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Dyvmsapi', - 'version' => '2017-05-25', - ], + 'info' => ['style' => 'RPC', 'product' => 'Dyvmsapi', 'version' => '2017-05-25'], 'directories' => [ [ - 'id' => 141310, - 'title' => 'Voice Notification', - 'type' => 'directory', - 'children' => [ - 'SingleCallByVoice', - ], - ], - [ - 'id' => 141312, - 'title' => 'Voice Verification Code', - 'type' => 'directory', - 'children' => [ - 'SingleCallByTts', - ], - ], - [ - 'id' => 141318, - 'title' => 'Task', - 'type' => 'directory', - 'children' => [ - 'CreateCallTask', - 'ListCallTask', - 'ExecuteCallTask', - 'ListCallTaskDetail', - ], - ], - [ - 'id' => 141314, - 'title' => 'Virtual Number', - 'type' => 'directory', - 'children' => [ - 'AddVirtualNumberRelation', - 'QueryVirtualNumberRelation', - 'ListServiceInstanceForPage', - ], - ], - [ - 'id' => 141360, - 'title' => 'Queries the Review State', - 'type' => 'directory', - 'children' => [ - 'QueryVoiceFileAuditInfo', - ], - ], - [ - 'id' => 141331, - 'title' => 'Queries Details', - 'type' => 'directory', - 'children' => [ - 'QueryCallDetailByCallId', - ], - ], - [ - 'id' => 141323, - 'title' => 'Voice IVR', - 'type' => 'directory', - 'children' => [ - 'IvrCall', - ], - ], - [ - 'id' => 141328, - 'title' => 'SmartCall', - 'type' => 'directory', 'children' => [ - 'SmartCall', - 'SmartCallOperate', + [ + 'children' => [ + [ + 'children' => ['CloudQueryTask', 'CloudMonitorTask', 'CloudPauseTask', 'CloudListTaskFile', 'CloudGetTask', 'CloudDeleteTaskTel', 'CloudDeleteTask', 'CloudCreateTask', 'CloudImportTaskTel', 'CloudStartTask', 'CloudUpdateTask'], + 'type' => 'directory', + 'title' => 'Call task operations', + ], + [ + 'children' => ['CloudUnassignAgentGroup', 'CloudAgentMonitorStatistics', 'CloudQueryAgentSkill', 'CloudQueryAgentGroup', 'CloudQueryAgent', 'CloudListAgentTel', 'CloudGetAgentStatus', 'CloudBatchUpdateAgent', 'CloudUpdateAgent', 'CloudQueryAgentCnoAndName', 'CloudListOnlineAgent', 'CloudListFreeAgent', 'CloudGetAgent', 'CloudDeleteAgentTel', 'CloudDeleteAgent', 'CloudBatchGetAgentStatus', 'CloudBatchCreateAgent', 'CloudCreateAgent'], + 'type' => 'directory', + 'title' => 'Agent management operations', + ], + [ + 'children' => ['CloudWebcall', 'CloudPreviewoutcall', 'CloudInterruptIvr', 'CloudAgentUnlink', 'CloudAgentSetUserData', 'CloudAgentLogin', 'CloudAgentLogout'], + 'type' => 'directory', + 'title' => 'Agent action operations', + ], + [ + 'children' => [ + 'CloudListSkill', 'CloudListQueueSkill', 'CloudListQueue', 'CloudListExten', 'CloudListAssignedAgentGroup', 'CloudListAgentGroup', 'CloudDeleteQueueSkill', 'CloudGetQueue', 'CloudGetExten', 'CloudDeleteSkill', 'CloudDeleteQueue', 'CloudDeleteExten', 'CloudDeleteEnterpriseTime', 'CloudDeleteAgentGroup', 'CloudCreateSkill', 'CloudCreateQueueSkill', 'CloudCreateQueue', 'CloudCreateExten', 'CloudCreateEnterpriseTime', 'CloudCreateAgentGroup', + 'CloudAssignAgentGroup', + ], + 'type' => 'directory', + 'title' => 'Call configuration management', + ], + [ + 'children' => ['CloudListCurlLog'], + 'type' => 'directory', + 'title' => 'Logs', + ], + [ + 'children' => ['CloudQueryWebcallCdr', 'CloudQueryPredictiveCallCdr', 'CloudQueryObCdr', 'CloudQueryIbCdr', 'CloudOutboundPreviewObReport', 'CloudOutboundObClidReport', 'CloudGetRecordUrl', 'CloudGetObCdr', 'CloudCreateAsr'], + 'type' => 'directory', + 'title' => 'Call records', + ], + [ + 'children' => ['CloudAgentWorkloadReport', 'CloudQueryRasrEvent', 'CloudGetAsr', 'CloudGetAreaCode'], + 'type' => 'directory', + 'title' => 'Others', + ], + ], + 'type' => 'directory', + 'title' => 'Cloud platform', + ], ], - ], - [ - 'id' => 141333, - 'title' => 'Intelligent Voice Robot', 'type' => 'directory', - 'children' => [ - 'CreateRobotTask', - 'BatchRobotSmartCall', - 'StartRobotTask', - 'StopRobotTask', - 'CancelOrderRobotTask', - 'CancelRobotTask', - 'DeleteRobotTask', - 'QueryRobotv2AllList', - 'QueryRobotTaskList', - 'QueryCallDetailByTaskId', - 'QueryRobotTaskDetail', - 'QueryRobotTaskCallList', - 'QueryRobotInfoList', - 'QueryRobotTaskCallDetail', - 'UploadRobotTaskCalledFile', - ], + 'title' => 'Industry cloud contact center', ], [ - 'id' => 141349, - 'title' => 'The China 400 Number', + 'children' => ['ListServiceInstanceForPage'], 'type' => 'directory', - 'children' => [ - 'GetHotlineQualificationByOrder', - 'ListHotlineTransferRegisterFile', - 'SubmitHotlineTransferRegister', - 'SetTransferCalleePoolConfig', - 'QueryCallInPoolTransferConfig', - 'QueryCallInTransferRecord', - 'SendVerification', - ], + 'title' => 'Service instances', ], [ - 'id' => 191750, - 'title' => '5G video call (invitation system)', + 'children' => ['SmartCall'], 'type' => 'directory', - 'children' => [ - 'SingleCallByVideo', - 'PlayVideoFile', - 'PauseVideoFile', - 'ResumeVideoFile', - 'QueryVideoPlayProgress', - 'UpgradeVideoFile', - 'DegradeVideoFile', - 'SkipVideoFile', - 'GetCallMediaType', - 'GetTemporaryFileUrl', - ], + 'title' => 'Intelligent voice interaction calls', ], [ - 'id' => 141358, - 'title' => 'Obtains the Token for Authentication', + 'children' => ['SingleCallByVideo', 'PlayVideoFile', 'PauseVideoFile', 'ResumeVideoFile', 'QueryVideoPlayProgress', 'UpgradeVideoFile', 'DegradeVideoFile', 'SkipVideoFile', 'GetCallMediaType', 'GetTemporaryFileUrl'], 'type' => 'directory', - 'children' => [ - 'GetToken', - ], + 'title' => '5G video calls (by invitation)', ], [ - 'id' => 166959, - 'title' => 'Setting a China 400 Number', - 'type' => 'directory', 'children' => [ - 'RecoverCallInConfig', - 'StopCallInConfig', + 'CancelCall', 'QueryVmsVirtualNumberRelationByPage', 'QueryVmsRealNumberCallConnectionRateInfo', 'AddVirtualNumberRelation', 'BatchRobotSmartCall', 'CancelOrderRobotTask', 'CancelRobotTask', 'CreateCallTask', 'CreateRobotTask', 'DeleteRobotTask', 'ExecuteCallTask', 'GetHotlineQualificationByOrder', 'GetToken', 'IvrCall', 'ListCallTask', 'ListCallTaskDetail', 'ListHotlineTransferRegisterFile', 'QueryCallDetailByCallId', 'QueryCallDetailByTaskId', 'QueryCallInPoolTransferConfig', + 'QueryCallInTransferRecord', 'QueryRobotInfoList', 'QueryRobotTaskCallDetail', 'QueryRobotTaskCallList', 'QueryRobotTaskDetail', 'QueryRobotTaskList', 'QueryRobotv2AllList', 'QueryVirtualNumberRelation', 'QueryVoiceFileAuditInfo', 'RecoverCallInConfig', 'SendVerification', 'SetTransferCalleePoolConfig', 'SingleCallByTts', 'SingleCallByVoice', 'SmartCallOperate', 'StartRobotTask', 'StopCallInConfig', 'StopRobotTask', 'SubmitHotlineTransferRegister', 'UploadRobotTaskCalledFile', ], - ], - [ - 'id' => 362618, - 'title' => null, 'type' => 'directory', - 'children' => [ - 'CancelCall', - 'QueryVmsVirtualNumberRelationByPage', - 'QueryVmsRealNumberCallConnectionRateInfo', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'SingleCallByVoice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddVirtualNumberRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -180,110 +93,40 @@ 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52712', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsX55VQQ', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '52666', + 'abilityTreeNodes' => ['FEATUREdyvmsT3BNLH'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CalledShowNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number displayed to the called party.'."\n" - ."\n" - .'* You do not need to specify this parameter if you use a voice notification file that uses the common outbound call mode. For more information, see [FAQ about the common outbound call mode](~~172104~~).'."\n" - .'* If you use a voice notification file that uses the dedicated outbound call mode, you must specify a number that you purchased. You can specify only one number. 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 number that you purchased.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0571****5678', - ], - ], - [ - 'name' => 'CalledNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number for receiving voice notifications.'."\n" - ."\n" - .'Number format:'."\n" - ."\n" - .'* In the Chinese mainland:'."\n" - ."\n" - .' * Mobile phone number, for example, 159\\*\\*\\*\\*0000.'."\n" - .' * Landline number, for example, 0571\\*\\*\\*\\*5678.'."\n" - ."\n" - .'* Outside the Chinese mainland: country code + phone number, for example, 85200\\*\\*\\*\\*00.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can specify only one called number for a request. For more information, see [How to use voice notifications in the Chinese mainland](~~150016~~) or [How to use voice notifications in regions outside the Chinese mainland](~~268810~~).'."\n" - ."\n" - .'* Voice notifications are sent to a called number at the following frequency: one time per minute, five times per hour, and 20 times per 24 hours.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1590****000', - ], - ], - [ - 'name' => 'VoiceCode', + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The voice ID of the voice notification file.'."\n" - ."\n" - .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications** or **Voice File Management**, and then click the **Voice Notification Files** tab to view the **voice ID**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', - ], + 'schema' => ['description' => 'The service name. Default value: **dyvms**.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dyvms', 'default' => 'dyvmsapi', 'title' => ''], ], [ - 'name' => 'PlayTimes', + 'name' => 'CorpNameList', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of times the voice notification file is played. Valid values: 1 to 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The company names. Separate multiple company names with commas (,).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '公司1,公司2', 'title' => ''], ], [ - 'name' => 'Volume', + 'name' => 'NumberList', 'in' => 'query', - 'schema' => [ - 'description' => 'The playback volume of the voice notification file. Valid values: 0 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The real numbers. Separate multiple real numbers with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1321111****,1322222****', 'title' => ''], ], [ - 'name' => 'Speed', + 'name' => 'RouteType', 'in' => 'query', - 'schema' => [ - 'description' => 'The playback speed of the voice notification file. Valid values: -500 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The route type. Valid values:'."\n" + ."\n" + .'* **0**: number location first.'."\n" + .'* **1**: random.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '99999', 'minimum' => '0', 'example' => '0', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'PhoneNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message.'."\n" - ."\n" - .'The value must be of the STRING type and 1 to 15 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '22596****', - ], + 'schema' => ['description' => 'The virtual number.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05516214****', 'title' => ''], ], ], 'responses' => [ @@ -292,184 +135,142 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.****'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E50FFA85-0B79-4421-A7BD-00B0A271966F', - ], - 'CallId' => [ - 'description' => 'The unique receipt ID for the call.'."\n" - ."\n" - .'You can call the [QueryCallDetailByCallId](~~393529~~) operation to query the details of the call.'."\n", - 'type' => 'string', - 'example' => '116004767703^102806****', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value 200 indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => ['description' => 'The numbers that failed to be associated.'."\n" + ."\n" + .'> If all numbers are associated, no value is returned for this parameter.'."\n", 'type' => 'string', 'example' => '1321111****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"E50FFA85-0B79-4421-A7BD-00B0A271966F\\",\\n \\"CallId\\": \\"116004767703^102806****\\"\\n}","type":"json"}]', - 'title' => 'SingleCallByVoice', - 'summary' => 'Sends a voice notification to a phone number by using a voice notification file.', - 'description' => '> Due to business adjustments, the updates of the voice notification and voice verification code services have been stopped in regions outside the Chinese mainland and the services have been discontinued since March 2022. Only qualified customers can continue using the voice notification and voice verification code services.'."\n" - ."\n" - .'You can call the [SingleCallByTts](~~393519~~) operation to send voice notifications with variables.'."\n" - ."\n" - .'### QPS limits'."\n" + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'You have not been authorized.', 'description' => 'You are not authorized to perform this operation.'], + ], + 500 => [ + ['errorCode' => 'VirtualNumber.Query.Fail', 'errorMessage' => 'Query virtual number fail.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to backend service exception.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"1321111****\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"\\nB0411112-6CF8-4752-81D1-918A1354AE49\\nsuccessful\\n1321111*****\\n200\\n","errorExample":""}]', + 'title' => 'AddVirtualNumberRelation', + 'summary' => 'Binds multiple real numbers to a service instance at a time.', + 'description' => '### QPS limits'."\n" ."\n" - .'You can call this operation up to 1,200 times per second per account.'."\n", + .'You can call this operation up to 200 times per second per account.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SingleCallByTts' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddVirtualNumberRelation'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:AddVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchRobotSmartCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52711', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsX55VQQ', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'CalledShowNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number displayed to the called party.'."\n" - ."\n" - .'* You do not need to specify this parameter if you use the text-to-speech (TTS) notification template or voice verification code template for outbound calls in the common mode. For more information, see [FAQ about the common outbound call mode](~~172104~~).'."\n" - .'* If you use the TTS notification template or voice verification code template for outbound calls in the dedicated mode, you must specify a number you purchased and only one number can be specified. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home) and choose **Voice Numbers** > **Real Number Management** to view the number you purchased.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0571****5678', - ], + 'schema' => ['description' => 'The number displayed to called parties, which must be a number you purchased. You can view the numbers you purchased in the [Voice Messaging Service console](https://dyvms.console.aliyun.com/dyvms.htm#/number/normal).'."\n" + ."\n" + .'You can set up to 100 numbers and separate the numbers with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '136****0000,138****0000', 'title' => ''], + ], + [ + 'name' => 'CorpName', + 'in' => 'query', + 'schema' => ['description' => 'The company name, which must be the same as the **company name** specified on the [qualification management page](https://dyvms.console.aliyun.com/dyvms.htm#/corp/normal).'."\n" + ."\n" + .'> This parameter is optional if **isSelfLine** is set to **true**.'."\n", 'type' => 'string', 'required' => false, 'example' => '阿里巴巴通信技术（北京）有限公司 ', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile phone number that receives voice notifications.'."\n" - ."\n" - .'* Number format in the Chinese mainland:'."\n" - ."\n" - .' * Mobile phone number, for example, 159\\*\\*\\*\\*0000.'."\n" - .' * Landline number, for example, 0571\\*\\*\\*\\*5678.'."\n" - ."\n" - .'* Number format outside the Chinese mainland: country code + phone number, for example, 85200\\*\\*\\*\\*00.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* Each request supports only one called number. For more information, see [How to use voice notifications in the Chinese mainland](~~150016~~) or [How to use voice verification codes in regions outside the Chinese mainland](~~270044~~).'."\n" - ."\n" - .'* Voice verification codes are sent to a called number at the following frequency: one time per minute, five times per hour, and 20 times per 24 hours.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1590****000', - ], + 'schema' => ['description' => 'The called number. Only mobile phone numbers in the Chinese mainland are supported.'."\n" + ."\n" + .'You can set up to 1,000 called numbers and separate the numbers with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''], ], [ - 'name' => 'TtsCode', + 'name' => 'DialogId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the approved TTS notification template or voice verification code template.'."\n" - ."\n" - .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), and choose **Voice Messages** > **Voice Verification Codes** or choose **Voice Messages** > **Voice Notifications** to view the **template ID**.'."\n" - ."\n" - .'> The account to which the TTS template belongs must be the same as the account that is used to call the SingleCallByTts operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TTS_100****', - ], + 'schema' => ['description' => 'The ID of the robot or communication script that is used to initiate a call.'."\n" + ."\n" + .'You can obtain the **communication script ID** from the [Communication script management](https://dyvms.console.aliyun.com/dyvms.htm#/smart-call/saas/robot/list) page.'."\n", 'type' => 'string', 'required' => true, 'example' => '100002970****', 'title' => ''], ], [ - 'name' => 'TtsParam', + 'name' => 'EarlyMediaAsr', 'in' => 'query', - 'schema' => [ - 'description' => 'The variables in the template, in the JSON format.'."\n" - ."\n" - .'> The variables in the template must be less than 250 characters in length. The length of each single variable is not limited. These variables do not support URLs. The variables in the verification code template support only digits and letters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"AckNum":"123456"}', - ], + 'schema' => ['description' => 'The speech recognition identifier of early media. The default value is **false**, which means that the speech recognition identifier of early media is not enabled.'."\n" + ."\n" + .'Set the parameter to **true** if you want to enable the speech recognition identifier of early media.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'PlayTimes', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of times a voice notification is played back in a call. Valid values: 1 to 3. Default value: 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The task name. The task name can be up to 30 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => '批量外呼任务 ', 'title' => ''], ], [ - 'name' => 'Volume', + 'name' => 'ScheduleTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The preset call time. This value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> This parameter is required only when **ScheduleCall** is set to **true**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', 'title' => ''], ], [ - 'name' => 'Speed', + 'name' => 'ScheduleCall', 'in' => 'query', - 'schema' => [ - 'description' => 'The playback speed. Valid value: -500 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'Specifies whether the call is scheduled. If you set this parameter to **true**, the **ScheduleTime** parameter is required.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'TtsParam', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom ID that is reserved for the caller of the operation when the request is initiated. This ID is returned to the caller in a receipt message.'."\n" - ."\n" - .'The value is of the STRING type and must be 1 to 15 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '225869*****', - ], + 'schema' => ['description' => 'The variable value of the TTS template, in the JSON format.'."\n" + ."\n" + .'The variable value must correspond to a number. The TtsParam parameter must be used together with the TtsParamHead parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"number":"1390000****","params":[“小王”,"小李","小周"]}]', 'title' => ''], + ], + [ + 'name' => 'TtsParamHead', + 'in' => 'query', + 'schema' => ['description' => 'The call tasks with variables, in the JSON format.'."\n" + ."\n" + .'The parameter value is a list of variable names. The TtsParamHead parameter must be used together with the TtsParam parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '["name1","name2","name3"]', 'title' => ''], + ], + [ + 'name' => 'IsSelfLine', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to call the self-managed line. Default value: **false**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -478,513 +279,426 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'CallId' => [ - 'description' => 'The unique receipt ID of the call.'."\n" - ."\n" - .'You can call the [QueryCallDetailByCallId](~~393529~~) operation to query the details of the call based on the receipt ID.'."\n", - 'type' => 'string', - 'example' => '116012354148^10281378****', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'TaskId' => ['description' => 'The unique ID of the robocall task. You can call the [QueryCallDetailByTaskId](~~393537~~) operation to query the details of the task based on the task ID.'."\n", 'type' => 'string', 'example' => '4001112222', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', - 'title' => 'SingleCallByTts', - 'summary' => 'Sends a voice verification code or a voice notification with variables to a specified phone number.', - 'description' => '* Due to business adjustments, the updates of the voice notification and voice verification code services have been stopped in regions outside the Chinese mainland and the services have been discontinued since March 2022. Only qualified customers can continue using the voice notification and voice verification code services.'."\n" - .'* For more information about voice plans or voice service billing, see [Pricing of VMS on China site (aliyun.com)](~~150083~~).'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"TaskId\\": \\"4001112222\\"\\n}","type":"json"}]', + 'title' => 'BatchRobotSmartCall', + 'summary' => 'Initiates outbound robocall tasks in a batch. You can set up to 100 numbers in a task.', + 'description' => '* 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.'."\n" + .'* The BatchRobotSmartCall operation is used to initiate an outbound robocall task by using the robot communication scripts preset in the Voice Messaging Service console.'."\n" ."\n" - .'### QPS limits'."\n" + .'## Prerequisites'."\n" ."\n" - .'You can call this operation up to 1,000 times per second per account.'."\n", + .'* You have passed the real-name verification for an enterprise user and passed the enterprise qualification review.'."\n" + .'* You have purchased numbers in the [Voice Messaging Service console](https://dyvms.console.aliyun.com/dyvms.htm#/number/normal).'."\n" + .'* You have added communication scripts on the [Communication script management](https://dyvms.console.aliyun.com/dyvms.htm#/smart-call/saas/robot/list) page, and the communication scripts have been approved.'."\n" + ."\n" + .'> Before you call this operation, make sure that you are familiar with the [billing](https://www.aliyun.com/price/product#/vms/detail) of Voice Messaging Service (VMS).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateCallTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchRobotSmartCall'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:BatchRobotSmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CancelCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'CallId', 'in' => 'query', + 'schema' => ['description' => 'The unique receipt ID for this call. Obtain it from the return information of the [ClickToDial](https://help.aliyun.com/document_detail/114040.htm) interface.', 'type' => 'string', 'required' => true, 'example' => '116012854210^10281427****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Aliyun', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the call was successfully canceled. Values:'."\n" + ."\n" + .'- **true**: Success'."\n" + ."\n" + .'- **false**: Failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'Description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the task template. Valid values:'."\n" - ."\n" - .'* **VMS_VOICE_TTS**: the text-to-speech (TTS) notification template.'."\n" - .'* **VMS_VOICE_CODE**: the voice notification template.'."\n" - .'* **VMS_TTS**: the voice verification code template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'VMS_VOICE_TTS', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","type":"json"}]', + 'title' => 'Cancel incoming and outgoing calls', + 'summary' => 'Call the CancelCall operation to cancel incoming and outgoing calls initiated by ClickToDial.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:CancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CancelOrderRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'TemplateCode', + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the ID of the robocall task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TTS_2122****', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\ttrue\\n","errorExample":""}]', + 'title' => 'CancelOrderRobotTask', + 'summary' => 'Cancels a robocall task that has not been started.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelOrderRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelOrderRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CancelRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TemplateName', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1045001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test Template', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', + 'title' => 'CancelRobotTask', + 'summary' => 'Terminates a robocall task.', + 'description' => 'Only a task in progress can be terminated by calling the CancelRobotTask operation, and the task cannot be resumed after it is terminated.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-06T11:06:45.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the calling number. Set the value to **LIST**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LIST', - 'default' => 'LIST', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CloudAgentLogin' => [ + 'summary' => 'Logs an agent in.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Resource', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The calling number. Only virtual numbers are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '05516214****', - ], + 'schema' => ['description' => 'The contact center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'DataType', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of called numbers. Valid values:'."\n" - ."\n" - .'* **LIST**: the called numbers that are separated by commas (,).'."\n" - .'* **JSON**: a JSON-formatted list of called numbers with template parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'JSON', - ], + 'schema' => ['description' => 'The agent ID. The value must be a 3- to 10-digit positive integer.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], [ - 'name' => 'Data', + 'name' => 'BindTel', 'in' => 'query', - 'schema' => [ - 'description' => 'The called numbers.'."\n" - ."\n" - .'* If you set DataType to LIST, the value of Data is in the LIST format.'."\n" - .'* If you set DataType to JSON, the value of Data is in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "paramNames":["name1","name2","key3"], "calleeList":[ { "callee":"131222222", "params":["zangsan","zhangsan01","zhangsan02"] }, { "callee":"131222222", "params":["zangsan","zhangsan01","zhangsan02"] }, ] }', - ], + 'schema' => ['description' => 'The bound phone number.', 'type' => 'string', 'required' => true, 'example' => '41008502', 'title' => ''], ], [ - 'name' => 'FireTime', + 'name' => 'BindType', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The binding type. Valid values: `1` (Phone), `2` (extension), and `3` (WebRTC).
Note: If the binding type is set to `WebRTC`, a successful API call does not enable you to make calls. If the binding type is set to `extension`, the device must be registered first. If the adaptive binding feature is enabled in your enterprise settings, the system automatically determines the binding type based on the phone number. In this case, the system-determined type overrides this parameter.
', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StopTime', + 'name' => 'LoginStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The agent\'s status after login. Valid values: `1` (set to idle) and `2` (set to busy). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ScheduleType', + 'name' => 'PauseDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The description for the busy state.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'AccessDeniedDetail' => ['description' => 'Details about the request failure.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ED815433-724A-4357-9991-A54AD2FF09FD', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudAgentLogin', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"ED815433-724A-4357-9991-A54AD2FF09FD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 123456\\n ED815433-724A-4357-9991-A54AD2FF09FD\\n","errorExample":""}]', - 'title' => 'CreateCallTask', - 'summary' => '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.', - 'description' => 'You can create up to 1,000 voice notifications for each task.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ListCallTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudAgentLogout' => [ + 'summary' => 'Logs out an agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: **10**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '10', - ], - ], - [ - 'name' => 'TemplateName', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test Template', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => 'The task state. Valid values:'."\n" - ."\n" - .'* **INIT**: The task is in the initial state.'."\n" - .'* **RELEASE**: The task is being parsed.'."\n" - .'* **RUNNING**: The task is running.'."\n" - .'* **STOP**: The task is suspended.'."\n" - .'* **SYSTEM_STOP**: The task is suspended by the system.'."\n" - .'* **CANCEL**: The task is canceled.'."\n" - .'* **SYSTEM_CANCEL**: The task is canceled by the system.'."\n" - .'* **DONE**: The task is complete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DONE', - ], + 'schema' => ['description' => 'The agent ID. It must be a positive integer with 3 to 10 digits.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'RemoveBinding', 'in' => 'query', - 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Aliyun', - ], + 'schema' => ['description' => 'Specifies whether to unbind the phone number from the agent. Valid values are `0` (do not unbind) and `1` (unbind). The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'IsKickout', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '151001****', - ], + 'schema' => ['description' => 'Specifies whether to send a kickout event to the agent. Valid values are `0` (do not send) and `1` (send). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'BizType', + 'name' => 'IgnoreOffline', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the task template. Valid values:'."\n" - ."\n" - .'* **VMS_VOICE_TTS**: the text-to-speech (TTS) notification template.'."\n" - .'* **VMS_VOICE_CODE**: the voice notification template.'."\n" - .'* **VMS_TTS**: the voice verification code template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'VMS_VOICE_CODE', - ], + 'schema' => ['description' => 'Specifies whether to ignore errors from repeated logout requests. Valid values are `0` (do not ignore) and `1` (ignore). The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5B0F201F-DCDA-45C2-AA92-1AE177F94991', - ], - 'Total' => [ - 'description' => 'The total number of tasks.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'AccessDeniedDetail' => ['description' => 'The reason for the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The task information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Task Information', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The task state. Valid values:'."\n" - ."\n" - .'* **INIT**: The task was in the initial state.'."\n" - .'* **RELEASE**: The task was being parsed.'."\n" - .'* **RUNNING**: The task was running.'."\n" - .'* **STOP**: The task was manually suspended.'."\n" - .'* **SYSTEM_STOP**: The task was suspended by the system.'."\n" - .'* **CANCEL**: The task was manually canceled.'."\n" - .'* **SYSTEM_CANCEL**: The task was canceled by the system.'."\n" - .'* **DONE**: The task was complete.'."\n", - 'type' => 'string', - 'example' => 'DONE', - ], - 'Data' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'DataType' => [ - 'description' => 'The type of the called number.'."\n", - 'type' => 'string', - 'example' => 'LIST', - ], - 'TaskName' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'Aliyun', - ], - 'CompletedCount' => [ - 'description' => 'The number of tasks that were complete.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => 'The total number of called numbers.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '600', - ], - 'TemplateName' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => 'Test Template'."\n", - ], - 'StopTime' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'BizType' => [ - 'description' => 'The type of the task template. Valid values:'."\n" - ."\n" - .'* **VMS_VOICE_TTS**: the TTS notification template.'."\n" - .'* **VMS_VOICE_CODE**: the voice notification template.'."\n" - .'* **VMS_TTS**: the voice verification code template.'."\n", - 'type' => 'string', - 'example' => 'VMS_VOICE_TTS', - ], - 'Resource' => [ - 'description' => 'The calling number.'."\n", - 'type' => 'string', - 'example' => '0571000****', - ], - 'TemplateCode' => [ - 'description' => 'The ID of the voice template.'."\n", - 'type' => 'string', - 'example' => 'TTS_2100****', - ], - 'FireTime' => [ - 'description' => 'The time when the scheduled task was started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'example' => '1614330978000', - ], - 'CompleteTime' => [ - 'description' => 'The time when the task was completed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'example' => '1614330986000', - ], - 'CompletedRate' => [ - 'description' => 'The task progress.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '26%', - ], - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123879546214', - ], - ], + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The operation result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code of the request.'."\n" + ."\n" + .'- `OK` indicates that the request was successful.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudAgentLogout', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"5B0F201F-DCDA-45C2-AA92-1AE177F94991\\",\\n \\"Total\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"INIT\\\\n\\",\\n \\"Data\\": \\"1\\",\\n \\"DataType\\": \\"LIST\\",\\n \\"TaskName\\": \\"验证码\\",\\n \\"CompletedCount\\": 2,\\n \\"TotalCount\\": 6,\\n \\"TemplateName\\": \\"身份验证\\",\\n \\"StopTime\\": \\"1614332378000\\",\\n \\"BizType\\": \\"VMS_TTS\\",\\n \\"Resource\\": \\"0571000****\\",\\n \\"TemplateCode\\": \\"TTS_28292****\\",\\n \\"FireTime\\": \\"1614330978000\\",\\n \\"CompleteTime\\": \\"1614330986000\\",\\n \\"CompletedRate\\": 0,\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5B0F201F-DCDA-45C2-AA92-1AE177F94991\\n 2\\n 1\\n 20\\n \\n DONE\\n 1614330978000\\n 05516214****\\n VMS_VOICE_TTS\\n 0fec3add-ef76-4c24-9728-666ababae9d6--alicomTask.xlsx\\n 1\\n TTS_21194****\\n 1\\n 测试任务\\n 10000\\n 特服号码测试模板\\n LIST\\n 1951001\\n 1614330986000\\n \\n \\n DONE\\n 1614159414000\\n 05516214****\\n VMS_VOICE_TTS\\n dyvms_51bae600-1e0c-4f65-9fb5-5811fd2226b7.xlsx\\n 2\\n TTS_21194****\\n 2\\n 任务中心\\n 10000\\n 特服号码测试模板\\n FILE\\n 195002\\n 1614159424000\\n \\n 200\\n","errorExample":""}]', - 'title' => 'ListCallTask', - 'summary' => '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.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ExecuteCallTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudAgentMonitorStatistics' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -992,292 +706,211 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '77094', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID. You can call the [CreateCallTask](~~CreateCallTask~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2256****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Fields', 'in' => 'query', - 'schema' => [ - 'description' => 'The task state. Valid values:'."\n" - ."\n" - .'* **RUNNING**'."\n" - .'* **STOP**'."\n" - .'* **CANCEL**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RUNNING', - ], + 'schema' => ['description' => 'The fields for real-time queue statistics. To specify multiple fields, separate them with a comma (,). If this parameter is omitted, all fields are returned by default.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], ], [ - 'name' => 'FireTime', + 'name' => 'Cnos', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the call task is executed, in the yyyy-MM-dd HH:mm:ss format.'."\n" - ."\n" - .'> You can leave this parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-03-09 00:00:00', - ], + 'schema' => ['description' => 'The IDs of the agents to query. To specify multiple agents, separate their IDs with a comma (,). If you omit this parameter, statistics for all agents in the account are returned by default.', 'type' => 'string', 'required' => false, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'IsUseGno', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query statistics by outbound group. Valid values are 0 (disabled, default) and 1 (enabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the outbound groups to query. To specify multiple outbound groups, separate their IDs with a comma (,). If this parameter is omitted, statistics for all agents in the account are returned by default. This parameter applies only when IsUseGno is set to 1.', 'type' => 'string', 'required' => false, 'example' => 'WH123', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page. The value must be between 1 and 500. The default is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['description' => 'The starting position for the query, used with Limit for pagination. For example, if you set Offset to 50 and Limit to 10, the API returns entries 51 through 60. The default is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'StartHour', + 'in' => 'query', + 'schema' => ['description' => 'The start hour of the query\'s time range. Valid values: 0–23.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'EndHour', + 'in' => 'query', + 'schema' => ['description' => 'The end hour of the query\'s time range. Valid values: 1–24.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23', 'title' => ''], + ], + [ + 'name' => 'IsNeedQueueName', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include the queue name in the response. Valid values are 0 (no, default) and 1 (yes).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is obsolete.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**: The request was successful.'."\n" - .'* **false**: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD', + 'type' => 'object', + 'properties' => [ + 'AgentStatistics' => [ + 'description' => 'An array of agent statistics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Idle_count' => ['description' => 'The total number of times the agent was idle.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'GroupName' => ['description' => 'The outbound group name.', 'type' => 'string', 'example' => 'gpname', 'title' => ''], + 'Max_idle_time' => ['description' => 'The maximum idle duration.', 'type' => 'string', 'example' => '52375', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'Ob_bridge_count' => ['description' => 'The total number of outbound bridged calls.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Min_ob_calling_time' => ['description' => 'The minimum outbound calling duration.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'Gno' => ['description' => 'The outbound group ID.', 'type' => 'string', 'example' => 'WH123', 'title' => ''], + 'Preview_ob_max_bridge_time' => ['description' => 'The maximum bridged duration for preview outbound calls.', 'type' => 'string', 'example' => '41', 'title' => ''], + 'Min_ob_wrapup_time' => ['description' => 'The minimum outbound wrap-up duration.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'Max_ob_bridge_time' => ['description' => 'The maximum outbound bridged duration.', 'type' => 'string', 'example' => '41', 'title' => ''], + 'Ob_bridge_time' => ['description' => 'The total outbound bridged duration.', 'type' => 'string', 'example' => '144', 'title' => ''], + 'Preview_ob_total_count' => ['description' => 'The total number of preview outbound calls.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Max_ob_wrapup_time' => ['description' => 'The maximum outbound wrap-up duration.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'Ob_wrapup_count' => ['description' => 'The total number of outbound wrap-ups.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'CurrentState' => ['description' => 'The current agent status, returned as a JSON string. The `state` field can have the following values: `stateIdle` (Idle), `statePause` (Busy), `stateCalling` (Calling), `stateInuse` (In a call), and `stateWrapup` (wrap-up). Other fields include `loginTime` (the login timestamp) and `startTime` (the timestamp when the current state began).', 'type' => 'string', 'example' => '{\\"state\\":\\"stateIdle\\",\\"startTime\\":\\"1491462675\\"}', 'title' => ''], + 'Ob_calling_time' => ['description' => 'The total outbound calling duration.', 'type' => 'string', 'example' => '67', 'title' => ''], + 'Idle_time' => ['description' => 'The total idle duration.', 'type' => 'string', 'example' => '54344', 'title' => ''], + 'QueueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => '0005,0006,test测试', 'title' => ''], + 'Preview_ob_valid_calls' => ['description' => 'The number of valid preview outbound calls.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Min_ob_bridge_time' => ['description' => 'The minimum outbound bridged duration.', 'type' => 'string', 'example' => '29', 'title' => ''], + 'Ob_wrapup_time' => ['description' => 'The total outbound wrap-up duration.', 'type' => 'string', 'example' => '120', 'title' => ''], + 'Preview_ob_agent_answered_count' => ['description' => 'The number of preview outbound calls answered by agents.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Preview_ob_min_bridge_time' => ['description' => 'The minimum bridged duration for preview outbound calls.', 'type' => 'string', 'example' => '29', 'title' => ''], + 'Preview_ob_both_answered_count' => ['description' => 'The number of preview outbound calls where both parties answered.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Ob_calling_count' => ['description' => 'The total number of outbound call attempts.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Min_idle_time' => ['description' => 'The minimum idle duration.', 'type' => 'string', 'example' => '9', 'title' => ''], + 'Preview_ob_total_bridge_time' => ['description' => 'The total bridged duration for preview outbound calls.', 'type' => 'string', 'example' => '144', 'title' => ''], + 'Max_ob_calling_time' => ['description' => 'The maximum outbound calling duration.', 'type' => 'string', 'example' => '31', 'title' => ''], + 'Preview_ob_valid_total_bridge_time' => ['description' => 'The total bridged duration of valid preview outbound calls.', 'type' => 'string', 'example' => '144', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'Total' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '26', 'title' => ''], + 'Date' => ['description' => 'The date in `yyyy-MM-dd` format.', 'type' => 'string', 'example' => '2026-04-06', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudAgentMonitorStatistics', + 'summary' => 'Real-time statistics on agent calls.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n 53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\n","errorExample":""}]', - 'title' => 'ExecuteCallTask', - 'summary' => 'Executes a call task.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AgentStatistics\\": [\\n {\\n \\"Idle_count\\": \\"5\\",\\n \\"GroupName\\": \\"gpname\\",\\n \\"Max_idle_time\\": \\"52375\\",\\n \\"Cno\\": \\"1111\\",\\n \\"Ob_bridge_count\\": \\"4\\",\\n \\"Min_ob_calling_time\\": \\"8\\",\\n \\"Gno\\": \\"WH123\\",\\n \\"Preview_ob_max_bridge_time\\": \\"41\\",\\n \\"Min_ob_wrapup_time\\": \\"30\\",\\n \\"Max_ob_bridge_time\\": \\"41\\",\\n \\"Ob_bridge_time\\": \\"144\\",\\n \\"Preview_ob_total_count\\": \\"5\\",\\n \\"Max_ob_wrapup_time\\": \\"30\\",\\n \\"Ob_wrapup_count\\": \\"4\\",\\n \\"CurrentState\\": \\"{\\\\\\\\\\\\\\"state\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"stateIdle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1491462675\\\\\\\\\\\\\\"}\\",\\n \\"Ob_calling_time\\": \\"67\\",\\n \\"Idle_time\\": \\"54344\\",\\n \\"QueueName\\": \\"0005,0006,test测试\\",\\n \\"Preview_ob_valid_calls\\": \\"4\\",\\n \\"Min_ob_bridge_time\\": \\"29\\",\\n \\"Ob_wrapup_time\\": \\"120\\",\\n \\"Preview_ob_agent_answered_count\\": \\"4\\",\\n \\"Preview_ob_min_bridge_time\\": \\"29\\",\\n \\"Preview_ob_both_answered_count\\": \\"4\\",\\n \\"Ob_calling_count\\": \\"5\\",\\n \\"Min_idle_time\\": \\"9\\",\\n \\"Preview_ob_total_bridge_time\\": \\"144\\",\\n \\"Max_ob_calling_time\\": \\"31\\",\\n \\"Preview_ob_valid_total_bridge_time\\": \\"144\\"\\n }\\n ],\\n \\"Total\\": \\"26\\",\\n \\"Date\\": \\"2026-04-06\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ListCallTaskDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudAgentSetUserData' => [ + 'summary' => 'Sets the user data for an agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '150001****', - ], - ], - [ - 'name' => 'CalledNum', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The called number.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1300000****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => 'The task state. Valid values:'."\n" - ."\n" - .'* **SUCCESS**: The task is successful.'."\n" - .'* **FAIL**: The task fails.'."\n" - .'* **INIT**: The task is not started.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', - ], + 'schema' => ['description' => 'The agent ID. The value must be a 3- to 10-digit positive integer.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Direction', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The user data direction. Valid values: `1` (agent side) and `2` (non-agent side).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: **10**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The user data, formatted as a JSON string. This value is injected as a channel variable. The format must be a simple key-value map, such as `{"key":"value"}`. Arrays and nested objects are not supported.', 'type' => 'string', 'required' => true, 'example' => '{"key":"value"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D692AC3D-CBA8-417F-BEB9-5B73718922D4', - ], - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'TotalPage' => [ - 'description' => 'The total number of pages.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of called numbers.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], + 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The information about the task.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The task state. Valid values:'."\n" - ."\n" - .'* **SUCCESS**: The task was successful.'."\n" - .'* **FAIL**: The task failed.'."\n" - .'* **INIT**: The task was not started.'."\n", - 'type' => 'string', - 'example' => 'FAIL', - ], - 'Duration' => [ - 'description' => 'The call duration. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'CalledNum' => [ - 'description' => 'The called number.'."\n", - 'type' => 'string', - 'example' => '1300000****', - ], - 'Caller' => [ - 'description' => 'The calling number.'."\n", - 'type' => 'string', - 'example' => '0571000****', - ], - 'Id' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The operation result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => 'The response body.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D692AC3D-CBA8-417F-BEB9-5B73718922D4\\",\\n \\"Code\\": \\"OK\\",\\n \\"TotalPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Duration\\": 10,\\n \\"CalledNum\\": \\"1390000****\\",\\n \\"Caller\\": \\"0571000****\\",\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 7C943A5D-E12A-4184-A5F8-CF57B92815E3\\n 500\\n 2\\n 1\\n 1000\\n \\n FAIL\\n 05516214****\\n 0\\n 1300001****\\n \\n \\n FAIL\\n 05516214****\\n 0\\n 1310000****\\n \\n OK\\n","errorExample":""}]', - 'title' => 'ListCallTaskDetail', - 'summary' => 'Queries the details of call tasks based on task IDs after call tasks are complete.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddVirtualNumberRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudAgentSetUserData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudAgentUnlink' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1285,431 +918,433 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '52666', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsT3BNLH', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The service name. Default value: **dyvms**.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'dyvms', - 'default' => 'dyvmsapi', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CorpNameList', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => 'The company names. Separate multiple company names with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Company 1', - ], + 'schema' => ['description' => 'The agent ID. The ID must be a 3- to 10-digit positive integer. Specify only one of the following parameters: Cno, UniqueId, or RequestUniqueId.', 'type' => 'string', 'required' => false, 'example' => '1111', 'title' => ''], ], [ - 'name' => 'NumberList', + 'name' => 'UniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The real numbers. Separate multiple real numbers with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1321111****,1322222****', - ], + 'schema' => ['description' => 'The unique call ID. Specify only one of the following parameters: Cno, UniqueId, or RequestUniqueId.', 'type' => 'string', 'required' => false, 'example' => '1233456789', 'title' => ''], ], [ - 'name' => 'RouteType', + 'name' => 'RequestUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The route type. Valid values:'."\n" - ."\n" - .'* **0**: number location first.'."\n" - .'* **1**: random.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999', - 'minimum' => '0', - 'example' => '0', - ], + 'schema' => ['description' => 'The unique request ID. Specify only one of the following parameters: Cno, UniqueId, or RequestUniqueId. Note: This parameter applies only to calls of the webcall type. You must first enable this feature in the management console.', 'type' => 'string', 'required' => false, 'example' => '1233456789', 'title' => ''], ], [ - 'name' => 'PhoneNum', + 'name' => 'Side', 'in' => 'query', - 'schema' => [ - 'description' => 'The virtual number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '05516214****', - ], + 'schema' => ['description' => 'The party to disconnect from the call. Valid values: 1 (agent) and 2 (non-agent). Default: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value 200 indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], + 'AccessDeniedDetail' => ['description' => 'Details about the request failure.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The numbers that failed to be associated.'."\n" - ."\n" - .'> If all numbers are associated, no value is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => '1321111****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'UnauthorizedOperation', - 'errorMessage' => 'You have not been authorized.', - ], - ], - 500 => [ - [ - 'errorCode' => 'VirtualNumber.Query.Fail', - 'errorMessage' => 'Query virtual number fail.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to backend service exception.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudAgentUnlink', + 'summary' => 'Disconnects an agent from a call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"1321111****\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"\\nB0411112-6CF8-4752-81D1-918A1354AE49\\nsuccessful\\n1321111*****\\n200\\n","errorExample":""}]', - 'title' => 'AddVirtualNumberRelation', - 'summary' => 'Binds multiple real numbers to a service instance at a time.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 200 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryVirtualNumberRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudAgentWorkloadReport' => [ + 'summary' => 'You can retrieve agent workload report data.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The service name. Default value: **dyvms**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dyvms', - 'default' => 'dyvms', - ], + 'schema' => ['description' => 'Call center ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'StatisticMethod', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Statistical method. Valid values: 0: hourly, 1: daily, 2: summary, 10: queue summary', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'TimeRangeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '20', - ], + 'schema' => ['description' => 'Report type. Valid values: 1: daily, 2: weekly, 3: monthly, 4: custom time range', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RouteType', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The route type. Valid values:'."\n" - ."\n" - .'**0**: number location first. **1**: random.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'Start date of the statistics period. Format: yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2025-06-13', 'title' => ''], ], [ - 'name' => 'QualificationId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The qualification ID.'."\n" - ."\n" - .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Qualifications\\&Communication Scripts > Qualification Management**, and then click **Details** in the Actions column to view the qualification ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000000542****', - ], + 'schema' => ['description' => 'End date of the statistics period. Format: yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2025-06-15', 'title' => ''], ], [ - 'name' => 'RegionNameCity', + 'name' => 'Cnos', 'in' => 'query', - 'schema' => [ - 'description' => 'The city to which the virtual number belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hangzhou', - ], + 'schema' => ['description' => 'Agent IDs. Query workload statistics for specific agents by agent ID. Separate multiple agent IDs with commas (,). By default, query workload statistics for all agents under the account.', 'type' => 'string', 'required' => false, 'example' => '1111,2222', 'title' => ''], ], [ - 'name' => 'SpecId', + 'name' => 'Gnos', 'in' => 'query', - 'schema' => [ - 'description' => 'The number type. Valid values:'."\n" - ."\n" - .'* **1**: the number provided by a virtual network operator, in the 05710000\\*\\*\\*\\* format.'."\n" - .'* **2**: the number provided by an Internet service provider (ISP).'."\n" - .'* **3**: a 5-digit phone number that starts with 95.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Outbound call IDs. Query workload statistics for specific agents by outbound call ID. By default, query workload statistics for all agents under the account.', 'type' => 'string', 'required' => false, 'example' => 'WH12', 'title' => ''], ], [ - 'name' => 'RelatedNum', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => 'The real number.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1705559****', - ], + 'schema' => ['description' => 'Query start position. Valid value: an integer greater than or equal to 0. Default value: 0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'PhoneNum', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => 'The virtual number.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '05516214****', - ], + 'schema' => ['description' => 'Number of entries to return. Maximum value: 1000. Default value: 10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value 200 indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'AccessDeniedDetail' => ['description' => 'Deprecated parameter', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '756BCB70-492E-5877-ABEB-03BB5CA28540', 'title' => ''], + 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The list of associations between virtual numbers and real numbers. The following fields are returned:'."\n" - ."\n" - .'* **relatedNum**: the real number.'."\n" - .'* **createTime**: the time when the number was activated.'."\n" - .'* **pageNo**: the page number.'."\n" - .'* **pageSize**: the number of entries per page.'."\n" - .'* **total**: the total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '{"data":[{"relatedNum":"1705559****","createTime":"2021-03-26 12:34:08"}],"pageSize":20,"total":1,"pageNo":1}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8FAD5988-B483-48A4-B251-6E8470A67371', + 'type' => 'object', + 'properties' => [ + 'TotalPageCount' => ['description' => 'Total number of pages', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of records.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size', 'type' => 'string', 'example' => '10', 'title' => ''], + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IbMonitorPickupDuration' => ['description' => 'Inbound call preemption duration', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObAnsweredDurationArray' => ['description' => 'Distribution of answered direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AvgIdleTime' => ['description' => 'Average idle time', 'type' => 'string', 'example' => '00:00:01', 'title' => ''], + 'PredictObValidTotalBridgeTime' => ['description' => 'Predictive outbound valid talk time', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], + 'ObMinWrapupTime' => ['description' => 'Minimum outbound wrap-up time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'DirectObMonitorThreewayCount' => ['description' => 'Total number of three-way conferences for monitored direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PredictObConsultCount' => ['description' => 'Number of predictive outbound consultations', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObCustomerRingingRate' => ['description' => 'Ringing rate', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'PreviewObValidTotalBridgeHour' => ['description' => 'Total hours of valid preview outbound talk time', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObBridgeCount' => ['description' => 'Number of outbound calls', 'type' => 'string', 'example' => '3', 'title' => ''], + 'IbMonitorSpyCount' => ['description' => 'Number of inbound monitoring listeners', 'type' => 'string', 'example' => '3', 'title' => ''], + 'PredictObMonitorBargeDuration' => ['description' => 'Predictive outbound barge-in duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbAnsweredDurationArray' => [ + 'description' => 'Distribution of answered calls', + 'items' => ['description' => '分布项', 'type' => 'string', 'example' => '""', 'title' => ''], + 'type' => 'array', + 'example' => '""', + 'title' => '', + ], + 'PreviewObMonitorWhisperDuration' => ['description' => 'Preview outbound whisper duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'AgentAnswerRate' => ['description' => 'Agent inbound answer rate', 'type' => 'string', 'example' => '80%', 'title' => ''], + 'AgentName' => ['description' => 'Agent name', 'type' => 'string', 'example' => 'test-3', 'title' => ''], + 'MinRestTime' => ['description' => 'Minimum rest time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObTransferCount' => ['description' => 'Number of webcall transfers', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbMinBridgeTime' => ['description' => 'Minimum inbound talk time', 'type' => 'string', 'example' => '00:00:10'."\n", 'title' => ''], + 'IbUniqueAnsweredCount' => ['description' => 'Number of inbound calls answered by agent', 'type' => 'string', 'example' => '3', 'title' => ''], + 'PauseTime' => ['description' => 'Total busy time', 'type' => 'string', 'example' => '00:00:10', 'title' => ''], + 'DirectObAnsweredCount' => ['description' => 'Number of customers who answered direct outbound calls', 'type' => 'string', 'example' => '4', 'title' => ''], + 'PredictObAgentAnsweredTime' => ['description' => 'Total duration of predicted outbound calls answered by agents', 'type' => 'integer', 'format' => 'int64', 'example' => '72', 'title' => ''], + 'PreviewObMonitorDisconnectCount' => ['description' => 'Number of forced disconnects for monitored preview outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ObAvgWrapupTime' => ['description' => 'Average outbound wrap-up time', 'type' => 'string', 'example' => '00:00:05', 'title' => ''], + 'ObAvgHoldTime' => ['description' => 'Average outbound hold time', 'type' => 'string', 'example' => '00:00:50', 'title' => ''], + 'IbTotalCount' => ['description' => 'Total number of inbound agents', 'type' => 'string', 'example' => '6', 'title' => ''], + 'IbUnansweredCount' => ['description' => 'Number of inbound calls not answered by agents', 'type' => 'string', 'example' => '2', 'title' => ''], + 'DirectObMonitorWhisperCount' => ['description' => 'Total number of whispers for monitored direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObMonitorSpyDuration' => ['description' => 'Preview outbound call monitoring duration', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbMonitorPickupCount' => ['description' => 'Number of inbound monitoring pickups', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbCustomerHangupCount' => ['description' => 'Number of customer hang-ups', 'type' => 'string', 'example' => '3', 'title' => ''], + 'PreviewObAnsweredDurationDscArray' => [ + 'description' => 'Description of preview outbound answered call distribution', + 'items' => ['description' => '描述项', 'type' => 'string', 'example' => '10-30秒内', 'title' => ''], + 'type' => 'array', + 'example' => '['."\n" + .' "10秒内",'."\n" + .' "10-30秒内",'."\n" + .' "30-60秒内",'."\n" + .' "1-2分钟内",'."\n" + .' "2-5分钟内",'."\n" + .' "5-10分钟内",'."\n" + .' "10-20分钟内",'."\n" + .' "20-30分钟内",'."\n" + .' "30-60分钟内",'."\n" + .' "1-2小时内",'."\n" + .' "2小时以上"'."\n" + .' ]', + 'title' => '', + ], + 'IbAgentHangupCount' => ['description' => 'Number of agent hang-ups', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PredictObMonitorSpyCount' => ['description' => 'Number of predictive outbound monitored spy sessions', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '123124', 'title' => ''], + 'PredictObAgentAnsweredHour' => ['description' => 'Total hours of predictive outbound calls answered by agents', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObWrapupCount' => ['description' => 'Number of outbound wrap-ups', 'type' => 'string', 'example' => '3', 'title' => ''], + 'IbMaxAnswerDelayTime' => ['description' => 'Maximum inbound answer delay time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PreviewObTotalBridgeTime' => ['description' => 'Talk time of preview outbound calls answered by both parties', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObMonitorSpyDuration' => ['description' => 'Duration of the Webcall listener', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PreviewObAgentAnsweredCount' => ['description' => 'Number of preview outbound calls answered by agents', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbAgentRefuseCount' => ['description' => 'Number of inbound calls rejected by agents', 'type' => 'string', 'example' => '0', 'title' => ''], + 'LoginTime' => ['description' => 'Total login time', 'type' => 'string', 'example' => '00:00:01', 'title' => ''], + 'DirectObConsultCount' => ['description' => 'Total number of direct outbound consultations', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbWrapupTime' => ['description' => 'Total inbound wrap-up time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PreviewObConsultCount' => ['description' => 'Number of preview outbound consultations', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Cno' => ['description' => 'Agent ID', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'IbMaxWrapupTime' => ['description' => 'Maximum inbound wrap-up time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObMonitorDisconnectCount' => ['description' => 'Number of forced disconnects for monitored webcalls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbMonitorThreewayCount' => ['description' => 'Number of inbound monitored three-way conferences', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MaxRestTime' => ['description' => 'Maximum rest time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PredictObTransferCount' => ['description' => 'Number of predictive outbound transfers', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObMonitorSpyCount' => ['description' => 'Total number of monitored spy sessions for direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ObCallingTime' => ['description' => 'Total outbound calling time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PreviewObTransferBridgeDuration' => ['description' => 'Talk time of transferred preview outbound calls answered by recipients', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbTotalAnswerDelayTime' => ['description' => 'Total inbound answer delay time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMinAnswerDelayTime' => ['description' => 'Minimum inbound answer delay time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PredictObMonitorBargeCount' => ['description' => 'Number of predictive outbound monitored barge-ins', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObBridgeDuration' => ['description' => 'Total duration of direct outbound calls', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbAvgCallingTime' => ['description' => 'Average inbound calling time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMaxBridgeTime' => ['description' => 'Maximum inbound talk time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PreviewObTotalCount' => ['description' => 'Total number of preview outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObMonitorThreewayCount' => ['description' => 'Number of monitored three-way conferences for preview outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObTransferCount' => ['description' => 'Total number of direct outbound transfers', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PredictObTotalCount' => ['description' => 'Total number of predictive outbound calls', 'type' => 'integer', 'format' => 'int64', 'example' => '39', 'title' => ''], + 'IbCallingTime' => ['description' => 'Total inbound calling time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMonitorBargeCount' => ['description' => 'Number of inbound monitored barge-ins', 'type' => 'string', 'example' => '0', 'title' => ''], + 'WebcallObAgentAnsweredTime' => ['description' => 'Webcall agent answer time in minutes', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'RestTime' => ['description' => 'Total rest time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PredictObValidTotalBridgeHour' => ['description' => 'Total hours of valid predictive outbound talk time', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbConsultCount' => ['description' => 'Number of inbound consultations', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbBridgeMinute' => ['description' => 'Inbound talk time in minutes', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PredictObMonitorDisconnectCount' => ['description' => 'Number of forced disconnects for monitored predictive outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'PreviewObAnsweredDurationArray' => [ + 'description' => 'Distribution of answered preview outbound calls', + 'items' => ['description' => '分布项', 'type' => 'string', 'example' => '""', 'title' => ''], + 'type' => 'array', + 'example' => '示例值示例值', + 'title' => '', + ], + 'AgentRate' => ['description' => 'Agent call answer rate', 'type' => 'string', 'example' => '0%', 'title' => ''], + 'WebcallObTotalCount' => ['description' => 'Total number of webcalls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbTotalMinute' => ['description' => 'Total inbound minutes', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MinIdleTime' => ['description' => 'Minimum idle time', 'type' => 'string', 'example' => '00:00:01', 'title' => ''], + 'PreviewObMonitorBargeCount' => ['description' => 'Number of monitored barge-ins for preview outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AgentStopTime' => ['description' => 'Agent deactivation time', 'type' => 'string', 'example' => '00:00:01', 'title' => ''], + 'IbBridgeTime' => ['description' => 'Inbound talk time answered by both parties', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMinHoldTime' => ['description' => 'Minimum inbound hold time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMonitorSpyDuration' => ['description' => 'Inbound spy duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMonitorDisconnectCount' => ['description' => 'Number of forced disconnects for monitored inbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObBridgeTime' => ['description' => 'Direct outbound talk time answered by both parties in minutes', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'ObMinHoldTime' => ['description' => 'Minimum outbound hold time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObConsultCount' => ['description' => 'Number of webcall consultations', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbMinCallingTime' => ['description' => 'Minimum inbound calling time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'Day' => ['description' => 'Statistics date', 'type' => 'string', 'example' => '2026-04-20', 'title' => ''], + 'MinPauseTime' => ['description' => 'Minimum idle time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMinWrapupTime' => ['description' => 'Minimum inbound wrap-up time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'RestCount' => ['description' => 'Number of rest periods', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbAvgBridgeTime' => ['description' => 'Average inbound talk time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'ObMaxHoldTime' => ['description' => 'Maximum outbound hold time', 'type' => 'string', 'example' => '00:00:01', 'title' => ''], + 'IbHoldCount' => ['description' => 'Number of call holds', 'type' => 'string', 'example' => '0', 'title' => ''], + 'WebcallObMonitorWhisperDuration' => ['description' => 'Webcall whisper duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'AvgPreviewObWaitTime' => ['description' => 'Average wait time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PreviewCustomerAnswerdRate' => ['description' => 'Preview outbound customer answer rate', 'type' => 'string', 'example' => '0%', 'title' => ''], + 'EnterpriseId' => ['description' => 'Enterprise ID', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'PredictObAnsweredCount' => ['description' => 'Number of predictive outbound calls answered by agents', 'type' => 'integer', 'format' => 'int64', 'example' => '27', 'title' => ''], + 'IbMonitorWhisperCount' => ['description' => 'Number of inbound monitored whispers', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObMonitorWhisperCount' => ['description' => 'Number of monitored whispers for preview outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IvrTransferCount' => ['description' => 'Number of preview outbound IVR transfers to agents', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObMonitorDisconnectCount' => ['description' => 'Total number of forced disconnects for monitored direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MaxPauseTime' => ['description' => 'Maximum idle time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMaxHoldTime' => ['description' => 'Maximum inbound hold time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbAvgWrapupTime' => ['description' => 'Average inbound wrap-up time', 'type' => 'string', 'example' => '00:00:10', 'title' => ''], + 'PredictObMonitorThreewayCount' => ['description' => 'Number of monitored three-way conferences for predictive outbound calls', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PreviewObTransferCount' => ['description' => 'Number of transferred preview outbound calls', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObMinCallingTime' => ['description' => 'Minimum outbound calling time', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AvgRestTime' => ['description' => 'Average rest time', 'type' => 'string', 'example' => '00:00:03', 'title' => ''], + 'IdleCount' => ['description' => 'Number of idle periods', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AvgPauseTime' => ['description' => 'Average busy time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'ObMaxCallingTime' => ['description' => 'Maximum outbound calling time', 'type' => 'string', 'example' => '00:00:03', 'title' => ''], + 'IbTotalTime' => ['description' => 'Total inbound talk time', 'type' => 'string', 'example' => '3', 'title' => ''], + 'AgentCreateTime' => ['description' => 'Agent creation time', 'type' => 'string', 'example' => '2019-04-20', 'title' => ''], + 'PreviewObTotalBridgeHour' => ['description' => 'Hours of preview outbound talk time answered by both parties', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObTotalCount' => ['description' => 'Total number of direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbUniqueUnansweredCount' => ['description' => 'Number of inbound calls not answered by agents', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObTransferBridgeCount' => ['description' => 'Number of transferred preview outbound calls answered by recipients', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IbTransferCount' => ['description' => 'Number of inbound transfers', 'type' => 'string', 'example' => '2', 'title' => ''], + 'PauseCount' => ['description' => 'Number of times the status was set to busy', 'type' => 'string', 'example' => '1', 'title' => ''], + 'HoursUtilization' => ['description' => 'Working hour utilization', 'type' => 'string', 'example' => '80%', 'title' => ''], + 'ObRealBridgeTime' => ['description' => 'Outbound talk time answered by both parties', 'type' => 'string', 'example' => '00:00:10', 'title' => ''], + 'ObCallingCount' => ['description' => 'Number of outbound calls', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IbMonitorBargeDuration' => ['description' => 'Inbound barge-in duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObMonitorBargeDuration' => ['description' => 'Webcall barge-in duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'TotalBridgeTime' => ['description' => 'Total talk time answered by both parties', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObMonitorSpyCount' => ['description' => 'Number of monitored spy sessions for webcalls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObValidTotalBridgeTime' => ['description' => 'Total valid talk time of direct outbound calls', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObMonitorBargeCount' => ['description' => 'Number of monitored barge-ins for webcalls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'RowName' => ['description' => 'Row name', 'type' => 'string', 'example' => '2017年06月13日[12345]', 'title' => ''], + 'ObAvgBridgeTime' => ['description' => 'Average outbound talk time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'ObBridgeTime' => ['description' => 'Total outbound talk time', 'type' => 'string', 'example' => 'ObBridgeTime', 'title' => ''], + 'IbHoldTime' => ['description' => 'Total inbound hold time', 'type' => 'string', 'example' => '00:00:00'."\n", 'title' => ''], + 'WebcallObMonitorWhisperCount' => ['description' => 'Number of monitored whispers for webcalls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IdleTime' => ['description' => 'Total idle time', 'type' => 'string', 'example' => '00:00:00'."\n", 'title' => ''], + 'ObHoldTime' => ['description' => 'Total outbound hold time', 'type' => 'string', 'example' => '00:00:10'."\n", 'title' => ''], + 'IbValidTotalBridgeTime' => ['description' => 'Inbound valid talk time', 'type' => 'string', 'example' => '00:00:10'."\n", 'title' => ''], + 'IbWrapupCount' => ['description' => 'Number of inbound wrap-ups', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObCustomerRingingCount' => ['description' => 'Number of rings', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IbAvgHoldTime' => ['description' => 'Average inbound hold time', 'type' => 'string', 'example' => '00:00:00'."\n", 'title' => ''], + 'PreviewObCustomerAnsweredTime' => ['description' => 'Preview outbound customer answer time', 'type' => 'string', 'example' => '00:00:00'."\n", 'title' => ''], + 'PreviewObAgentAnsweredTime' => ['description' => 'Preview outbound agent answer time', 'type' => 'string', 'example' => '00:00:01'."\n", 'title' => ''], + 'PredictObAnsweredDurationArray' => ['description' => 'Distribution of answered predictive outbound calls', 'type' => 'string', 'example' => '""', 'title' => ''], + 'IbCallingCount' => ['description' => 'Number of inbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IvrTransferBridgeDuration' => ['description' => 'Talk time of preview outbound IVR transfers answered by both parties', 'type' => 'string', 'example' => '00:00:01', 'title' => ''], + 'DirectObTotalTime' => ['description' => 'Total minutes of direct outbound calls', 'type' => 'string', 'example' => '00:00:22', 'title' => ''], + 'DateTimeRange' => ['description' => 'Time range', 'type' => 'string', 'example' => '2017年06月13日', 'title' => ''], + 'DirectObAnsweredDurationDscArray' => [ + 'description' => 'Description of direct outbound answered call distribution', + 'items' => ['description' => '分布项', 'type' => 'string', 'example' => '0', 'title' => ''], + 'type' => 'array', + 'example' => '示例值示例值', + 'title' => '', + ], + 'PreviewObValidTotalBridgeTime' => ['description' => 'Total valid talk time of preview outbound calls', 'type' => 'string', 'example' => '00:00:22'."\n", 'title' => ''], + 'PredictObMonitorWhisperCount' => ['description' => 'Number of monitored whispers for predictive outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'QueueName' => ['description' => 'Queue name', 'type' => 'string', 'example' => 'name3', 'title' => ''], + 'ObMaxWrapupTime' => ['description' => 'Maximum outbound wrap-up time', 'type' => 'string', 'example' => '00:00:22'."\n", 'title' => ''], + 'ObAvgCallingTime' => ['description' => 'Average outbound calling time', 'type' => 'string', 'example' => '00:00:11'."\n", 'title' => ''], + 'ObMinBridgeTime' => ['description' => 'Minimum outbound talk time', 'type' => 'string', 'example' => '00:00:02'."\n", 'title' => ''], + 'ObHoldCount' => ['description' => 'Number of outbound holds', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IbBridgeCount' => ['description' => 'Number of inbound calls', 'type' => 'string', 'example' => '2', 'title' => ''], + 'PreviewObMonitorBargeDuration' => ['description' => 'Preview outbound barge-in duration', 'type' => 'string', 'example' => '00:00:00'."\n", 'title' => ''], + 'IbAnsweredDurationDscArray' => [ + 'description' => 'Description of inbound answered call distribution', + 'items' => ['description' => '描述项', 'type' => 'string', 'example' => '5-10分钟内，2-5分钟内', 'title' => ''], + 'type' => 'array', + 'example' => '示例值示例值', + 'title' => '', + ], + 'CallUtilization' => ['description' => 'Call utilization', 'type' => 'string', 'example' => '66%', 'title' => ''], + 'IbMonitorWhisperDuration' => ['description' => 'Inbound whisper duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'DirectObValidCalls' => ['description' => 'Number of valid answered direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DirectObMonitorBargeCount' => ['description' => 'Total number of barge-ins for direct outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbValidCalls' => ['description' => 'Number of valid inbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PredictObMonitorSpyDuration' => ['description' => 'Predictive outbound spy duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbAnsweredCount' => ['description' => 'Number of inbound calls answered by agents', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObMonitorSpyCount' => ['description' => 'Number of monitored spy sessions for preview outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PredictObMonitorWhisperDuration' => ['description' => 'Predictive outbound whisper duration', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'ObMaxBridgeTime' => ['description' => 'Maximum outbound talk time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'PreviewObValidCalls' => ['description' => 'Number of valid preview outbound calls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ObWrapupTime' => ['description' => 'Total outbound wrap-up time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'WebcallObAnsweredDurationArray' => ['description' => 'Distribution of answered webcalls', 'type' => 'string', 'example' => '""', 'title' => ''], + 'WebcallObMonitorThreewayCount' => ['description' => 'Number of monitored three-way conferences for webcalls', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewObAnsweredCount' => ['description' => 'Number of preview outbound calls answered by both parties', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PredictObValidCalls' => ['description' => 'Number of valid predictive outbound calls', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'WebcallObAnsweredCount' => ['description' => 'Number of webcalls answered by both parties', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PreviewAgentAnswerdRate' => ['description' => 'Preview outbound agent answer rate', 'type' => 'string', 'example' => '33%', 'title' => ''], + 'MaxIdleTime' => ['description' => 'Maximum idle time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IbMaxCallingTime' => ['description' => 'Maximum inbound calling time', 'type' => 'string', 'example' => '00:00:10', 'title' => ''], + 'IbUniqueTotalCount' => ['description' => 'Number of inbound calls to agents', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IbAvgAnswerDelayTime' => ['description' => 'Average inbound answer delay time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IvrTransferBridgeCount' => ['description' => 'Number of preview outbound IVR transfers answered by agents', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'List of report data', + 'title' => '', + ], + ], + 'description' => 'Returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. OK indicates a successful request. For other error codes, see the error code list.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'VirtualNumber.NotOwn', - 'errorMessage' => 'You can only use your own virtual number.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudAgentWorkloadReport', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"regionNameProvince\\\\\\": \\\\\\"湖南\\\\\\",\\\\n \\\\\\"relatedNum\\\\\\": \\\\\\"0734284****\\\\\\",\\\\n \\\\\\"specName\\\\\\": \\\\\\"联通全国\\\\\\",\\\\n \\\\\\"createTime\\\\\\": \\\\\\"2021-07-02 16:04:49\\\\\\",\\\\n \\\\\\"regionNameCity\\\\\\": \\\\\\"衡阳\\\\\\",\\\\n \\\\\\"corpName\\\\\\": \\\\\\"阿里巴巴通信技术（北京）有限公司\\\\\\",\\\\n \\\\\\"virtualNum\\\\\\": \\\\\\"05710000****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"pageSize\\\\\\": 20,\\\\n \\\\\\"total\\\\\\": 1,\\\\n \\\\\\"pageNo\\\\\\": 1\\\\n}\\",\\n \\"RequestId\\": \\"8FAD5988-B483-48A4-B251-6E8470A67371\\"\\n}","errorExample":""},{"type":"xml","example":"\\n8FAD5988-B483-48A4-B251-6E8470A67371\\n\\n \\n 1705559****\\n 2021-03-26 12:34:08\\n \\n 20\\n 1\\n 1\\n\\n200\\n","errorExample":""}]', - 'title' => 'QueryVirtualNumberRelation', - 'summary' => '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.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 200 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"756BCB70-492E-5877-ABEB-03BB5CA28540\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalPageCount\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"List\\": [\\n {\\n \\"IbMonitorPickupDuration\\": \\"0\\",\\n \\"DirectObAnsweredDurationArray\\": \\"0\\",\\n \\"AvgIdleTime\\": \\"00:00:01\\",\\n \\"PredictObValidTotalBridgeTime\\": 33,\\n \\"ObMinWrapupTime\\": \\"00:00:00\\",\\n \\"DirectObMonitorThreewayCount\\": \\"0\\",\\n \\"PredictObConsultCount\\": \\"0\\",\\n \\"PreviewObCustomerRingingRate\\": \\"100%\\",\\n \\"PreviewObValidTotalBridgeHour\\": \\"1\\",\\n \\"ObBridgeCount\\": \\"3\\",\\n \\"IbMonitorSpyCount\\": \\"3\\",\\n \\"PredictObMonitorBargeDuration\\": \\"00:00:00\\",\\n \\"IbAnsweredDurationArray\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"PreviewObMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"AgentAnswerRate\\": \\"80%\\",\\n \\"AgentName\\": \\"test-3\\",\\n \\"MinRestTime\\": \\"00:00:00\\",\\n \\"WebcallObTransferCount\\": \\"0\\",\\n \\"IbMinBridgeTime\\": \\"00:00:10\\\\n\\",\\n \\"IbUniqueAnsweredCount\\": \\"3\\",\\n \\"PauseTime\\": \\"00:00:10\\",\\n \\"DirectObAnsweredCount\\": \\"4\\",\\n \\"PredictObAgentAnsweredTime\\": 72,\\n \\"PreviewObMonitorDisconnectCount\\": \\"0\\",\\n \\"ObAvgWrapupTime\\": \\"00:00:05\\",\\n \\"ObAvgHoldTime\\": \\"00:00:50\\",\\n \\"IbTotalCount\\": \\"6\\",\\n \\"IbUnansweredCount\\": \\"2\\",\\n \\"DirectObMonitorWhisperCount\\": \\"0\\",\\n \\"PreviewObMonitorSpyDuration\\": \\"0\\",\\n \\"IbMonitorPickupCount\\": \\"0\\",\\n \\"IbCustomerHangupCount\\": \\"3\\",\\n \\"PreviewObAnsweredDurationDscArray\\": [\\n \\"10-30秒内\\"\\n ],\\n \\"IbAgentHangupCount\\": \\"0\\",\\n \\"PredictObMonitorSpyCount\\": \\"0\\",\\n \\"Id\\": \\"123124\\",\\n \\"PredictObAgentAnsweredHour\\": \\"1\\",\\n \\"ObWrapupCount\\": \\"3\\",\\n \\"IbMaxAnswerDelayTime\\": \\"00:00:00\\",\\n \\"PreviewObTotalBridgeTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorSpyDuration\\": \\"00:00:00\\",\\n \\"PreviewObAgentAnsweredCount\\": \\"0\\",\\n \\"IbAgentRefuseCount\\": \\"0\\",\\n \\"LoginTime\\": \\"00:00:01\\",\\n \\"DirectObConsultCount\\": \\"0\\",\\n \\"IbWrapupTime\\": \\"00:00:00\\",\\n \\"PreviewObConsultCount\\": \\"0\\",\\n \\"Cno\\": \\"1111\\",\\n \\"IbMaxWrapupTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorDisconnectCount\\": \\"0\\",\\n \\"IbMonitorThreewayCount\\": \\"0\\",\\n \\"MaxRestTime\\": \\"00:00:00\\",\\n \\"PredictObTransferCount\\": \\"0\\",\\n \\"DirectObMonitorSpyCount\\": \\"0\\",\\n \\"ObCallingTime\\": \\"00:00:00\\",\\n \\"PreviewObTransferBridgeDuration\\": \\"00:00:00\\",\\n \\"IbTotalAnswerDelayTime\\": \\"00:00:00\\",\\n \\"IbMinAnswerDelayTime\\": \\"00:00:00\\",\\n \\"PredictObMonitorBargeCount\\": \\"0\\",\\n \\"DirectObBridgeDuration\\": \\"00:00:00\\",\\n \\"IbAvgCallingTime\\": \\"00:00:00\\",\\n \\"IbMaxBridgeTime\\": \\"00:00:00\\",\\n \\"PreviewObTotalCount\\": \\"0\\",\\n \\"PreviewObMonitorThreewayCount\\": \\"0\\",\\n \\"DirectObTransferCount\\": \\"0\\",\\n \\"PredictObTotalCount\\": 39,\\n \\"IbCallingTime\\": \\"00:00:00\\",\\n \\"IbMonitorBargeCount\\": \\"0\\",\\n \\"WebcallObAgentAnsweredTime\\": \\"00:00:00\\",\\n \\"RestTime\\": \\"00:00:00\\",\\n \\"PredictObValidTotalBridgeHour\\": \\"0\\",\\n \\"IbConsultCount\\": \\"0\\",\\n \\"IbBridgeMinute\\": \\"00:00:00\\",\\n \\"PredictObMonitorDisconnectCount\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"PreviewObAnsweredDurationArray\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"AgentRate\\": \\"0%\\",\\n \\"WebcallObTotalCount\\": \\"0\\",\\n \\"IbTotalMinute\\": \\"0\\",\\n \\"MinIdleTime\\": \\"00:00:01\\",\\n \\"PreviewObMonitorBargeCount\\": \\"0\\",\\n \\"AgentStopTime\\": \\"00:00:01\\",\\n \\"IbBridgeTime\\": \\"00:00:00\\",\\n \\"IbMinHoldTime\\": \\"00:00:00\\",\\n \\"IbMonitorSpyDuration\\": \\"00:00:00\\",\\n \\"IbMonitorDisconnectCount\\": \\"0\\",\\n \\"DirectObBridgeTime\\": \\"00:00:00\\",\\n \\"ObMinHoldTime\\": \\"00:00:00\\",\\n \\"WebcallObConsultCount\\": \\"0\\",\\n \\"IbMinCallingTime\\": \\"00:00:00\\",\\n \\"Day\\": \\"2026-04-20\\",\\n \\"MinPauseTime\\": \\"00:00:00\\",\\n \\"IbMinWrapupTime\\": \\"00:00:00\\",\\n \\"RestCount\\": \\"0\\",\\n \\"IbAvgBridgeTime\\": \\"00:00:00\\",\\n \\"ObMaxHoldTime\\": \\"00:00:01\\",\\n \\"IbHoldCount\\": \\"0\\",\\n \\"WebcallObMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"AvgPreviewObWaitTime\\": \\"00:00:00\\",\\n \\"PreviewCustomerAnswerdRate\\": \\"0%\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"PredictObAnsweredCount\\": 27,\\n \\"IbMonitorWhisperCount\\": \\"0\\",\\n \\"PreviewObMonitorWhisperCount\\": \\"0\\",\\n \\"IvrTransferCount\\": \\"0\\",\\n \\"DirectObMonitorDisconnectCount\\": \\"0\\",\\n \\"MaxPauseTime\\": \\"00:00:00\\",\\n \\"IbMaxHoldTime\\": \\"00:00:00\\",\\n \\"IbAvgWrapupTime\\": \\"00:00:10\\",\\n \\"PredictObMonitorThreewayCount\\": \\"1\\",\\n \\"PreviewObTransferCount\\": \\"1\\",\\n \\"ObMinCallingTime\\": \\"0\\",\\n \\"AvgRestTime\\": \\"00:00:03\\",\\n \\"IdleCount\\": \\"0\\",\\n \\"AvgPauseTime\\": \\"00:00:00\\",\\n \\"ObMaxCallingTime\\": \\"00:00:03\\",\\n \\"IbTotalTime\\": \\"3\\",\\n \\"AgentCreateTime\\": \\"2019-04-20\\",\\n \\"PreviewObTotalBridgeHour\\": \\"0\\",\\n \\"DirectObTotalCount\\": \\"0\\",\\n \\"IbUniqueUnansweredCount\\": \\"0\\",\\n \\"PreviewObTransferBridgeCount\\": \\"1\\",\\n \\"IbTransferCount\\": \\"2\\",\\n \\"PauseCount\\": \\"1\\",\\n \\"HoursUtilization\\": \\"80%\\",\\n \\"ObRealBridgeTime\\": \\"00:00:10\\",\\n \\"ObCallingCount\\": \\"1\\",\\n \\"IbMonitorBargeDuration\\": \\"00:00:00\\",\\n \\"WebcallObMonitorBargeDuration\\": \\"00:00:00\\",\\n \\"TotalBridgeTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorSpyCount\\": \\"0\\",\\n \\"DirectObValidTotalBridgeTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorBargeCount\\": \\"0\\",\\n \\"RowName\\": \\"2017年06月13日[12345]\\",\\n \\"ObAvgBridgeTime\\": \\"00:00:00\\",\\n \\"ObBridgeTime\\": \\"ObBridgeTime\\",\\n \\"IbHoldTime\\": \\"00:00:00\\\\n\\",\\n \\"WebcallObMonitorWhisperCount\\": \\"0\\",\\n \\"IdleTime\\": \\"00:00:00\\\\n\\",\\n \\"ObHoldTime\\": \\"00:00:10\\\\n\\",\\n \\"IbValidTotalBridgeTime\\": \\"00:00:10\\\\n\\",\\n \\"IbWrapupCount\\": \\"0\\",\\n \\"PreviewObCustomerRingingCount\\": \\"1\\",\\n \\"IbAvgHoldTime\\": \\"00:00:00\\\\n\\",\\n \\"PreviewObCustomerAnsweredTime\\": \\"00:00:00\\\\n\\",\\n \\"PreviewObAgentAnsweredTime\\": \\"00:00:01\\\\n\\",\\n \\"PredictObAnsweredDurationArray\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IbCallingCount\\": \\"0\\",\\n \\"IvrTransferBridgeDuration\\": \\"00:00:01\\",\\n \\"DirectObTotalTime\\": \\"00:00:22\\",\\n \\"DateTimeRange\\": \\"2017年06月13日\\",\\n \\"DirectObAnsweredDurationDscArray\\": [\\n \\"0\\"\\n ],\\n \\"PreviewObValidTotalBridgeTime\\": \\"00:00:22\\\\n\\",\\n \\"PredictObMonitorWhisperCount\\": \\"0\\",\\n \\"QueueName\\": \\"name3\\",\\n \\"ObMaxWrapupTime\\": \\"00:00:22\\\\n\\",\\n \\"ObAvgCallingTime\\": \\"00:00:11\\\\n\\",\\n \\"ObMinBridgeTime\\": \\"00:00:02\\\\n\\",\\n \\"ObHoldCount\\": \\"1\\",\\n \\"IbBridgeCount\\": \\"2\\",\\n \\"PreviewObMonitorBargeDuration\\": \\"00:00:00\\\\n\\",\\n \\"IbAnsweredDurationDscArray\\": [\\n \\"5-10分钟内，2-5分钟内\\"\\n ],\\n \\"CallUtilization\\": \\"66%\\",\\n \\"IbMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"DirectObValidCalls\\": \\"0\\",\\n \\"DirectObMonitorBargeCount\\": \\"0\\",\\n \\"IbValidCalls\\": \\"0\\",\\n \\"PredictObMonitorSpyDuration\\": \\"00:00:00\\",\\n \\"IbAnsweredCount\\": \\"0\\",\\n \\"PreviewObMonitorSpyCount\\": \\"0\\",\\n \\"PredictObMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"ObMaxBridgeTime\\": \\"00:00:00\\",\\n \\"PreviewObValidCalls\\": \\"0\\",\\n \\"ObWrapupTime\\": \\"00:00:00\\",\\n \\"WebcallObAnsweredDurationArray\\": \\"\\\\\\"\\\\\\"\\",\\n \\"WebcallObMonitorThreewayCount\\": \\"0\\",\\n \\"PreviewObAnsweredCount\\": \\"0\\",\\n \\"PredictObValidCalls\\": 0,\\n \\"WebcallObAnsweredCount\\": \\"0\\",\\n \\"PreviewAgentAnswerdRate\\": \\"33%\\",\\n \\"MaxIdleTime\\": \\"00:00:00\\",\\n \\"IbMaxCallingTime\\": \\"00:00:10\\",\\n \\"IbUniqueTotalCount\\": \\"0\\",\\n \\"IbAvgAnswerDelayTime\\": \\"00:00:00\\",\\n \\"IvrTransferBridgeCount\\": \\"0\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ListServiceInstanceForPage' => [ - 'summary' => '分页查询服务实例列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CloudAssignAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Code', - 'in' => 'query', - 'schema' => [ - 'title' => '服务实例号', - 'description' => '服务实例号', - 'type' => 'string', - 'required' => false, - 'example' => '0571****1234', - ], - ], - [ - 'name' => 'SceneId', - 'in' => 'query', - 'schema' => [ - 'title' => '场景ID', - 'description' => '场景ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '56', - ], - ], - [ - 'name' => 'UsageId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'title' => '用途ID', - 'description' => '用途ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '89', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'RelationNumber', + 'name' => 'Gno', 'in' => 'query', - 'schema' => [ - 'title' => '关联实体号码', - 'description' => '关联实体号码', - 'type' => 'string', - 'required' => false, - 'example' => '131****1111', - ], + 'schema' => ['description' => 'The ID of the outbound group. Agents specified by the `Cnos` parameter are assigned to this group. An outbound group can contain a maximum of 1,000 agents.', 'type' => 'string', 'required' => false, 'example' => 'WH123', 'title' => ''], ], [ - 'name' => 'Pager', + 'name' => 'Cnos', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'title' => '每页数量，默认10，最大100', - 'description' => '每页数量，默认10，最大100', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'PageIndex' => [ - 'title' => '当前页码', - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The agent IDs. Separate multiple IDs with a comma (,). You can specify up to 1,000 agent IDs in a single request. An agent can belong to only one outbound group. If you assign an agent who is already in another group, the system automatically moves the agent to the new group.', 'type' => 'string', 'required' => false, 'example' => '1000,1111', 'title' => ''], ], ], 'responses' => [ @@ -1717,678 +1352,269 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'title' => '请求唯一id', - 'description' => '请求唯一id', - 'type' => 'string', - 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE', - ], - 'Message' => [ - 'title' => '响应消息', - 'description' => '响应消息', - 'type' => 'string', - 'example' => '每页最大100条！', - ], - 'Model' => [ - 'title' => '', - 'description' => '', + 'AccessDeniedDetail' => ['description' => 'Deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总数', - 'description' => '总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - ], - 'TotalPage' => [ - 'title' => '总页数', - 'description' => '总页数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '76', - ], - 'PageSize' => [ - 'title' => '每页数量', - 'description' => '每页数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59', - ], - 'PageNo' => [ - 'title' => '当前页码', - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '47', - ], - 'Records' => [ - 'title' => '', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '绑定状态：绑定；未绑定', - 'description' => '绑定状态：绑定；未绑定', - 'type' => 'string', - 'example' => '绑定', - ], - 'SceneId' => [ - 'title' => '场景ID', - 'description' => '场景ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '29', - ], - 'GmtCreate' => [ - 'title' => '创建时间（时间戳）', - 'description' => '创建时间（时间戳）', - 'type' => 'string', - 'example' => '1759109856000', - ], - 'SceneName' => [ - 'title' => '场景名称', - 'description' => '场景名称', - 'type' => 'string', - 'example' => '系统通知', - ], - 'InstanceStatus' => [ - 'title' => '实例状态（init：初始化；usable：可用；unusable：不可用；destory：注销）', - 'description' => '实例状态（init：初始化；usable：可用；unusable：不可用；destory：注销）', - 'type' => 'string', - 'example' => 'init', - ], - 'RelationTotalCount' => [ - 'title' => '关联总数量', - 'description' => '关联总数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'UsageId' => [ - 'title' => '用途ID', - 'description' => '用途ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '96', - ], - 'Code' => [ - 'title' => '服务实例号', - 'description' => '服务实例号', - 'type' => 'string', - 'example' => '0571****1234', - ], - 'RelationAvailableCount' => [ - 'title' => '关联可用数量', - 'description' => '关联可用数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'AliUid' => [ - 'title' => 'aliUid', - 'description' => 'aliUid', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11******123', - ], - 'Name' => [ - 'title' => '服务实例名称', - 'description' => '服务实例名称', - 'type' => 'string', - 'example' => '测试数据', - ], - 'UsageName' => [ - 'title' => '用途名称', - 'description' => '用途名称', - 'type' => 'string', - 'example' => '语音通知', - ], - ], - ], - 'example' => '', - ], + 'Result' => ['description' => 'The operation result. A value of `0` indicates success, and `1` indicates failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', 'example' => '', ], - 'Code' => [ - 'title' => '状态码，OK表示响应成功', - 'description' => '状态码，OK表示响应成功', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudAssignAgentGroup', + 'summary' => 'Use this operation to assign agents to an outbound group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"每页最大100条！\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 36,\\n \\"TotalPage\\": 76,\\n \\"PageSize\\": 59,\\n \\"PageNo\\": 47,\\n \\"Records\\": [\\n {\\n \\"Status\\": \\"绑定\\",\\n \\"SceneId\\": 29,\\n \\"GmtCreate\\": \\"1759109856000\\",\\n \\"SceneName\\": \\"系统通知\\",\\n \\"InstanceStatus\\": \\"init\\",\\n \\"RelationTotalCount\\": 33,\\n \\"UsageId\\": 96,\\n \\"Code\\": \\"0571****1234\\",\\n \\"RelationAvailableCount\\": 30,\\n \\"AliUid\\": 0,\\n \\"Name\\": \\"测试数据\\",\\n \\"UsageName\\": \\"语音通知\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryVoiceFileAuditInfo' => [ - 'summary' => 'Queries the review state of a voice file.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudBatchCreateAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '120076', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'VoiceCodes', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the voice file. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications** or **Voice File Management**, and then click the **Voice Notification Files** tab to view the **voice ID**.'."\n" - ."\n" - .'> You can query up to 10 voice files each time. Separate the voice file names with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '8501d2eb-efbb-471f-xxx8-****.wav', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'BusinessType', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the voice file. Valid values:'."\n" - ."\n" - .'* **0** (default): the voice notification file.'."\n" - .'* **2**: the recording file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - 'enum' => [], - ], + 'schema' => ['description' => 'The starting agent ID. The ID must be a positive integer 3 to 10 digits long.', 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'The value OK indicates that the request was successful. For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Return Results', - 'type' => 'object', - 'properties' => [ - 'VoiceCode' => [ - 'description' => 'The code of the voice file.'."\n", - 'type' => 'string', - 'example' => '8501d2eb-efbb-471f-xxx8-****.wav', - ], - 'AuditState' => [ - 'description' => 'The review state of the voice file. Valid values:'."\n" - ."\n" - .'* **AUDIT_STATE_INIT**: The voice file was under review.'."\n" - .'* **AUDIT_STATE_PASS**: The voice file was approved.'."\n" - .'* **AUDIT_STATE_NOT_PASS**: The voice file was rejected.'."\n" - .'* **AUDIT_STATE_UPLOADING**: The voice file was approved and is being uploaded.'."\n" - .'* **AUDIT_STATE_REDOING**: The voice file was being reprocessed.'."\n" - .'* **AUDIT_SATE_CANCEL**: The review of the voice file was canceled.'."\n" - .'* **AUDIT_PAUSE**: The review of the voice file was suspended.'."\n" - .'* **AUDIT_ORDER_FINISHED**: The voice file was approved by the ticket system and was waiting for the review of the Internet service provider (ISP).'."\n", - 'type' => 'string', - 'example' => 'AUDIT_STATE_NOT_PASS', - ], - 'RejectInfo' => [ - 'description' => 'The reason why the voice file was rejected.'."\n", - 'type' => 'string', - 'example' => 'This business is not supported', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Query.Voice.File.Limit', - 'errorMessage' => 'Voice file query number cannot exceed 10', - ], + [ + 'name' => 'EndCno', + 'in' => 'query', + 'schema' => ['description' => 'The ending agent ID. The ID must be a positive integer 3 to 10 digits long. You can create up to 100 agents per request.', 'type' => 'string', 'required' => true, 'example' => '103', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"VoiceCode\\": \\"8501d2eb-efbb-471f-xxx8-****.wav\\",\\n \\"AuditState\\": \\"AUDIT_STATE_NOT_PASS\\",\\n \\"RejectInfo\\": \\"如电话沟通，该业务暂不支持\\"\\n }\\n ],\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', - 'title' => 'QueryVoiceFileAuditInfo', - ], - 'QueryCallDetailByCallId' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the agent. The value must be URL-encoded in UTF-8.', 'type' => 'string', 'required' => true, 'example' => '李四', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '52694', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s area code.', 'type' => 'string', 'required' => true, 'example' => '010', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'Active', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the call.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The CallId parameter is included in the response parameters of the outbound call operation that you call to initiate a call.'."\n" - ."\n" - .'* The date when the call specified by CallId is started must be the same as the date specified by QueryDate.'."\n" - ."\n" - .'* The value of CallId must match the value of ProdId.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '116014888060^10281631****', - ], + 'schema' => ['description' => 'Specifies whether to activate the agent. Valid values: `1` (active) and `0` (inactive). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProdId', + 'name' => 'Power', 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID. Valid values:'."\n" - ."\n" - .'* **11000000300006**: voice notification. You can call the [SingleCallByVoice](https://help.aliyun.com/document_detail/393517.html) operation to send a voice notification of the voice notification file type to the specified number.'."\n" - .'* **11010000138001**: voice verification code. You can call the [SingleCallByTts](https://help.aliyun.com/document_detail/393519.html) operation to send a voice verification code or a text-to-speech (TTS) voice notification to the specified number.'."\n" - .'* **11000000300005**: IVR. You can call the [IvrCall](https://help.aliyun.com/document_detail/393521.html) operation to initiate an interactive voice call to the specified number.'."\n" - .'* **11000000300009**: Session Initiation Protocol (SIP) call.'."\n" - .'* **11030000180001**: intelligent outbound call.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11000000300006', - ], + 'schema' => ['description' => 'The role of the agent. Valid values: `1` (supervisor) and `0` (regular agent). Default value: `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'QueryDate', + 'name' => 'CallPower', 'in' => 'query', - 'schema' => [ - 'description' => 'The time at which call details are queried. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> The system queries the call records that are generated within 24 hours after the specified point in time. For example, if you specify the time 20:00:01 on November 21, 2022, the system queries the call records that are generated for the specified call ID from 20:00:01 on November 21, 2022, to 20:00:01 on November 22, 2022.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1671552000000', - ], + 'schema' => ['description' => 'The call permission for the agent. Valid values: `0` (Unlimited), `1` (Domestic Long Distance), `2` (Local City), and `3` (Internal Calls). Default value: `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => 'The details of the call, in the JSON format.'."\n" - ."\n" - .'* **caller**: the calling number.'."\n" - .'* **startDate**: the time when the call was started.'."\n" - .'* **stateDesc**: the description of the call state.'."\n" - .'* **duration**: the call duration. Unit: seconds. The value **0** indicates that the user was not connected.'."\n" - .'* **callerShowNumber**: the calling number displayed to the called party.'."\n" - .'* **gmtCreate**: the time when the call request was received.'."\n" - .'* **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](~~55085~~).'."\n" - .'* **endDate**: the time when the call was ended.'."\n" - .'* **calleeShowNumber**: the number displayed to the called party.'."\n" - .'* **callee**: the called number.'."\n" - .'* **aRingTime**: the time when Line A started to ring, in the yyyy-MM-dd HH:mm:ss format.'."\n" - .'* **aEndTime**: the time when ringing on Line A ended, in the yyyy-MM-dd HH:mm:ss format.'."\n" - .'* **bRingTime**: the time when Line B started to ring, in the yyyy-MM-dd HH:mm:ss format.'."\n" - .'* **bEndTime**: the time when ringing on Line B ended, in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'string', - '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****"}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - ], - ], - ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s wrap-up time, in seconds. Default value: `10`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"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****\\\\\\"}\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n {\\"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****\\"}\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n","errorExample":""}]', - 'title' => 'QueryCallDetailByCallId', - 'summary' => 'Queries the details of a call.', - 'description' => 'QueryCallDetailByCallId is a common query operation. You can call this operation to query the details of a voice notification, voice verification code, interactive voice response (IVR), intelligent inbound voice call, intelligent outbound voice call, or intelligent robocall.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'IvrCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the agent can make outbound calls. Valid values: `1` (yes) and `0` (no). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52686', - 'abilityTreeNodes' => [ - 'FEATUREdyvms4MLIJE', + [ + 'name' => 'ObClidType', + 'in' => 'query', + 'schema' => ['description' => 'The rule for displaying the caller ID for outbound calls. Valid values: `1` (Default), `2` (Random), `3` (By Area Code), and `4` (Dynamic). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'ObClid', 'in' => 'query', - 'schema' => [ - 'description' => 'The calling number.'."\n" - ."\n" - .'The value must be a number you purchased. Each request supports only one calling number. In most cases, a calling number is configured with the maximum number of concurrent requests. New requests fail if the maximum number of concurrent requests is reached. 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 number you purchased.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0571****5678', - ], + 'schema' => ['description' => 'The pass-through number to use as the caller ID. This can be an enterprise trunk number or a configured caller ID. This parameter is required when `ObClidType` is set to `2` or `3`.', 'type' => 'string', 'required' => false, 'example' => '22223333', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'ObClidProperty', 'in' => 'query', - 'schema' => [ - 'description' => 'The called number.'."\n" - ."\n" - .'Only phone numbers in the Chinese mainland are supported. Each request supports only one called number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1590****000', - ], + 'schema' => ['description' => 'Dynamic caller ID properties in JSON format. Example: `{"isMatchCapital":0,"areaCodeRule":1}`. This parameter applies only when `ObClidType` is set to `4`. The JSON string contains the following properties: `isMatchCapital` specifies whether to match the phone number of a provincial capital (`1`: yes, `0`: no), and `areaCodeRule` specifies the area code matching rule (`1`: Match the agent\'s area code, `2`: Match the customer\'s area code).', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1}', 'title' => ''], ], [ - 'name' => 'StartCode', + 'name' => 'IbRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'The voice that is played when the call begins.'."\n" - ."\n" - .'* If you use a voice notification file, this parameter specifies the voice ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > Voice Notifications, and then click the **Voice Notification Files** tab to view the voice ID.'."\n" - .'* If you use a text-to-speech (TTS) template, this parameter specifies the template ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **TTS Template** tab to view the template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TTS_1234****', - ], + 'schema' => ['description' => 'Specifies whether to enable recording for inbound calls. Valid values: `1` (yes) and `0` (no). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StartTtsParams', + 'name' => 'ObRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'The variables in the TTS template, in the JSON format.'."\n" - ."\n" - .'> This parameter is required when the StartCode parameter is set to the ID of a TTS template that contains variables.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"xxx","code":"123"}', - ], + 'schema' => ['description' => 'Specifies whether to enable recording for outbound calls. Valid values: `1` (yes) and `0` (no). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PlayTimes', + 'name' => 'SkillIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of replay times. Valid values: 1 to 3.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The skill IDs to assign to the agent. To assign multiple skills, separate the IDs with commas (`,`). Example: `1,2,3`. If you specify this parameter, you must also specify `SkillLevels`.', 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], ], [ - 'name' => 'ByeCode', + 'name' => 'SkillLevels', 'in' => 'query', - 'schema' => [ - 'description' => 'The end voice.'."\n" - ."\n" - .'* If you use a voice notification file, this parameter specifies the voice ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **Voice Notification Files** tab to view the voice ID.'."\n" - .'* If you use a TTS template, this parameter specifies the template ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **TTS Template** tab to view the template ID.'."\n" - ."\n" - .'> The value of the ByeCode parameter must be of the same type as the value of the StartCode parameter. This means that both parameters must specify voice IDs or TTS template IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TTS_1234****', - ], + 'schema' => ['description' => 'The levels for the skills specified in `SkillIds`. A smaller value indicates a higher proficiency. The skill levels must correspond to the skill IDs. To specify multiple levels, separate them with commas (`,`). For example, if `SkillIds` is `1,2,3` and `SkillLevels` is `5,1,1`, skill `1` is assigned level `5`, while skills `2` and `3` are assigned level `1`.', 'type' => 'string', 'required' => false, 'example' => '5,1,1', 'title' => ''], ], [ - 'name' => 'ByeTtsParams', + 'name' => 'IsAsr', 'in' => 'query', - 'schema' => [ - 'description' => 'The variables in the TTS template, in the JSON format.'."\n" - ."\n" - .'> This parameter is required when the ByeCode parameter is set to the ID of a TTS template that contains variables.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"xxx","code":"123"} ', - ], + 'schema' => ['description' => 'Specifies whether to enable ASR transcription. Valid values: `1` (yes) and `0` (no). Default value: `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Timeout', + 'name' => 'IsQualityCheck', 'in' => 'query', - 'schema' => [ - 'description' => 'The timeout period for the subscriber to press a key. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3000', - ], + 'schema' => ['description' => 'Specifies whether to enable agent quality check. Valid values: `1` (yes) and `0` (no). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'WebrtcUrlType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID that is reserved for the caller of the operation. This ID is returned to the caller in a receipt message.'."\n" - ."\n" - .'The value is of the STRING type and must be 1 to 15 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PR0210428****', - ], + 'schema' => ['description' => 'The type of address to return for the WebRTC softphone. Valid values: `0` (enterprise default), `1` (public domain name), `2` (leased line domain name), `3` (public IP), and `4` (leased line IP).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MenuKeyMap', + 'name' => 'Comment', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'repeatList', + 'schema' => ['description' => 'A descriptive remark.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The information about the key pressed by the subscriber.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key that can be pressed by the subscriber.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'TtsParams' => [ - 'description' => 'The variables in the TTS template, in the JSON format.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter specifies the substitution relationship of the variables in the TTS template if the value of the **MenuKeyMap.N.Code** parameter is set to the ID of the TTS template.'."\n" - ."\n" - .'* This parameter is required if the value of the **MenuKeyMap.N.Code** parameter is set to the ID of a TTS template that contains variables.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"xxx","code":"123"}', - ], - 'Code' => [ - 'description' => 'The voice that corresponds to the key specified by the **MenuKeyMap.N.Key** parameter.'."\n" - ."\n" - .'* If you use a voice notification file, this parameter specifies the voice ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **Voice Notification Files** tab to view the voice ID.'."\n" - .'* If you use a TTS template, this parameter specifies the template ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **TTS Template** tab to view the template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TTS_1235****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the request failure.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'The number of successfully created agents.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Cnos' => ['description' => 'The IDs of the successfully created agents.', 'type' => 'string', 'example' => '100,101,102,103', 'title' => ''], + 'Fail' => ['description' => 'The number of agents that failed to be created.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Other' => ['description' => 'The number of agents that were created but failed to be assigned a skill group.', 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- The value OK indicates that the request was successful.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 15, + 'description' => 'The response body.', + 'title' => '', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudBatchCreateAgent', + 'summary' => 'You can add up to 100 agents in a single batch.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Success\\": \\"4\\",\\n \\"Cnos\\": \\"100,101,102,103\\",\\n \\"Fail\\": \\"0\\",\\n \\"Other\\": \\"0\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudBatchGetAgentStatus' => [ + 'summary' => 'Queries the real-time status of a batch of agents by their agent IDs.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'The agent IDs to query. Separate multiple agent IDs with commas (`,`). You can query a maximum of 100 agents per request.', 'type' => 'string', 'required' => true, 'example' => '2000,2001', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'CallId' => [ - 'description' => 'The unique receipt ID of the call.'."\n" - ."\n" - .'You can call the [QueryCallDetailByCallId](~~393529~~) operation to query the details of the call based on the receipt ID.'."\n", - 'type' => 'string', - 'example' => '116012354148^10281378****', + 'AccessDeniedDetail' => ['description' => 'Details about the request failure.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'State' => ['description' => 'The overall agent status. This is a combination of the agent login status and the agent device status. Valid values: `offline`, `idle`, `busy`, `wrap-up`, `calling`, `ringing`, `on hold`, and `in a call`.', 'type' => 'string', 'example' => '空闲', 'title' => ''], + 'StateAction' => ['description' => 'The action that corresponds to the agent status. This parameter is returned only when the agent is not offline.', 'type' => 'string', 'example' => 'Idle', 'title' => ''], + 'LoginStatus' => ['description' => 'The agent login status. Valid values: `0` (offline), `1` (online), `2` (busy), and `3` (wrap-up).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DeviceStatus' => ['description' => 'The agent device status. This parameter is returned only when the agent is not offline. Valid values: `-1` (error), `0` (idle), `1` (locked), `2` (inviting), `3` (ringing), and `4` (in use).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MainUniqueId' => ['description' => 'The unique ID of the call that the agent is handling. This parameter is returned when the agent device status is `1` (locked), `2` (inviting), `3` (ringing), or `4` (in use).', 'type' => 'string', 'example' => 'test3321.sip33', 'title' => ''], + ], + 'description' => 'The object that contains agent status details.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code of the request.'."\n" + ."\n" + .'- `OK` indicates that the request was successful.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', - 'title' => 'IvrCall', - 'summary' => 'Initiates an interactive voice response (IVR) call to a specified number.', - 'description' => '* Your enterprise qualification is approved. For more information, see [Submit enterprise qualifications](~~149795~~).'."\n" - .'* Voice numbers are purchased. For more information, see [Purchase numbers](~~149794~~).'."\n" - .'* When the subscriber answers the call, the subscriber hears a voice that instructs the subscriber to press a key as needed. If the [message receipt](~~112503~~) feature is enabled, the Voice Messaging Service (VMS) platform returns the information about the key pressed by the subscriber to the business system. The key information includes the order confirmation, questionnaire survey, and satisfaction survey completed by the subscriber.'."\n" - ."\n" - .'## QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SmartCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudBatchGetAgentStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"State\\": \\"空闲\\",\\n \\"StateAction\\": \\"Idle\\",\\n \\"LoginStatus\\": \\"1\\",\\n \\"DeviceStatus\\": \\"0\\",\\n \\"MainUniqueId\\": \\"test3321.sip33\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudBatchUpdateAgent' => [ + 'summary' => 'Batch-updates basic agent information, excluding assigned skills.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2396,3469 +1622,2706 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52713', - 'abilityTreeNodes' => [ - 'FEATUREdyvms59DC26', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number displayed to the called party. The value must be the number you purchased.'."\n" - ."\n" - .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home) and choose **Voice Numbers** > **Real Number Management** to view the number you purchased.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0571****5678', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'Cnos', 'in' => 'query', - 'schema' => [ - 'description' => 'The called number. Only phone numbers in the Chinese mainland are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1590****0000', - ], + 'schema' => ['description' => 'A comma-separated list of the agent IDs to update. You can specify a maximum of 100 IDs.
Each agent ID must be a positive integer from 3 to 10 digits long.
', 'type' => 'string', 'required' => true, 'example' => '0001,0002,00103', 'title' => ''], ], [ - 'name' => 'VoiceCode', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The recording file that is played back in the intelligent outbound call.'."\n" - ."\n" - .'The file can be an online file, a voice file uploaded from the Voice Messaging Service console, or a text-to-speech (TTS) template that contains variables. You can specify multiple files and a TTS variable together. Separate them with commas (,). The values of the variables in the TTS template are specified by the **VoiceCodeParam** parameter.'."\n" - ."\n" - .'* If you use an online file as the recording file, set the value of **VoiceCode** to the URL of the file that can be accessed over the Internet.'."\n" - .'* If you use a voice file uploaded from the Voice Messaging Service console as the recording file, set the value of **VoiceCode** to the voice ID of the file. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice File Management**, click the **Intelligent Speech Interaction Recording File** tab, and then click **Details** in the Actions column to view the voice ID.'."\n" - .'* If you use a TTS template that contains variables as the recording file, set the value of **VoiceCode** to a variable name such as $name$, and also set a value for the variable in the **VoiceCodeParam** parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', - ], + 'schema' => ['description' => 'The agent name. The value must be URL-encoded in UTF-8.', 'type' => 'string', 'required' => false, 'example' => '李四', 'title' => ''], ], [ - 'name' => 'RecordFlag', + 'name' => 'AreaCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to record the conversation. Valid values:'."\n" - ."\n" - .'* **true**: The conversation is recorded.'."\n" - .'* **false**: The conversation is not recorded.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Volume', - 'in' => 'query', - 'schema' => [ - 'description' => 'The volume at which the recording file is played. Valid values: -4 to 4. We recommend that you set the value of this parameter to **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Speed', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AsrModelId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Automatic Speech Recognition (ASR) model.'."\n" - ."\n" - .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home) and view the ID of the ASR model on the **ASR Model Management** page.'."\n" - ."\n" - .'> You must specify the ASR model when you call the SmartCall operation. We recommend that you specify either of the AsrModelId and AsrBaseId parameters.'."\n" - ."\n" - .'* If you specify only the AsrModelId parameter, the specified ASR model is used.'."\n" - ."\n" - .'* If you specify only the AsrBaseId parameter, the specified ASR base model is used.'."\n" - ."\n" - .'* If you specify neither of the two parameters, the default value customer_service\\_8k is used for the AsrBaseId parameter. This means that the default Mandarin ASR base model is used.'."\n" - ."\n" - .'* If you specify both parameters, make sure that their values do not conflict with each other.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2070aca1eff146f9a7bc826f1c3d****', - ], - ], - [ - 'name' => 'PauseTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pause duration. The system determines the end of a sentence based on the pause duration of the user in the conversation. Unit: milliseconds. Valid values: 300 to 1200.****'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you specify a value out of the valid range, the default value **800** is used.'."\n" - ."\n" - .'* You cannot change the parameter value after specifying it.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '800', - ], - ], - [ - 'name' => 'MuteTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The silence duration. The system determines the end of the conversation based on the silence duration of the user. Unit: milliseconds. Valid values: 1000 to 20000.****'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you specify a value out of the valid range, the default value **10000** is used.'."\n" - ."\n" - .'* The parameter value can be adjusted during the conversation. The last setting prevails.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The agent\'s area code.', 'type' => 'string', 'required' => false, 'example' => '010', 'title' => ''], ], [ - 'name' => 'ActionCodeBreak', + 'name' => 'Active', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the playback of the recording file can be interrupted. Default value: **true**. The default value indicates that the playback of the recording file can be interrupted.'."\n" - ."\n" - .'If you set the value of this parameter to false, the playback of the recording file cannot be interrupted even if the value of action_break is set to true.'."\n" - ."\n" - .'> The value of action_code_break takes precedence over the value of action_break.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether the agent is active. Valid values: `0` (inactive) and `1` (active). The default value is `1` (active).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'AgentType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID that is reserved for the caller of the operation. This ID is returned to the caller in a receipt message.'."\n" - ."\n" - .'The value is of the STRING type and must be 1 to 15 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '342268*****', - ], + 'schema' => ['description' => 'The agent type. Valid values: `1` (phone agent) and `2` (computer agent). The default value is `1` (phone agent).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DynamicId', + 'name' => 'Power', 'in' => 'query', - 'schema' => [ - 'description' => 'The dynamic extension ID that is reserved for the caller of the operation. This ID is returned in the callback URL and is used as the development identifier of the customer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcdefgh', - ], + 'schema' => ['description' => 'The agent\'s permission level. Valid values: `1` (supervisor) and `0` (standard agent). The default value is `0` (standard agent).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EarlyMediaAsr', + 'name' => 'CallPower', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable speech recognition of early media. Valid values:'."\n" - ."\n" - .'* **false** (default): Speech recognition of early media is disabled.'."\n" - .'* **true**: Speech recognition of early media is enabled.'."\n" - ."\n" - .'> If you set the value of this parameter to **true**, the reason why the call is not answered is recorded.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The call permission. Valid values: `0` (unrestricted), `1` (domestic long-distance), `2` (local), and `3` (internal calls only). The default value is `0` (unrestricted).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'VoiceCodeParam', + 'name' => 'Wrapup', 'in' => 'query', - 'schema' => [ - 'description' => 'The value of the TTS variable, in the JSON format. This value must match the TTS variable specified by the **VoiceCode** parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"hello"}', - ], + 'schema' => ['description' => 'The wrap-up time, in seconds. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'SessionTimeout', + 'name' => 'IsOb', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum call duration. The call is automatically hung up when the maximum call duration is reached. Unit: seconds.'."\n" - ."\n" - .'> The maximum call duration is 3,600 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'Specifies whether the agent can make outbound calls. Valid values: `0` (disallowed) and `1` (allowed). The default value is `1` (allowed).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ActionCodeTimeBreak', + 'name' => 'ObClidType', 'in' => 'query', - 'schema' => [ - 'description' => 'The duration that the user keeps speaking. The playback of the recording file is interrupted when this duration is reached. Unit: milliseconds.'."\n" - ."\n" - .'If the value of ActionCodeBreak is set to **true** for the recording file and the duration that the user keeps speaking reaches the specified duration, the playback of the recording file is interrupted. If you do not specify ActionCodeTimeBreak or set the value of ActionCodeTimeBreak to 0, the setting of ActionCodeBreak does not take effect.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'The outbound caller ID rule. Valid values: `1` (default), `2` (random), `3` (by area code), and `4` (dynamic caller ID). The default value is `1` (default).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'TtsStyle', + 'name' => 'ObClid', 'in' => 'query', - 'schema' => [ - 'description' => 'The sound style for TTS variable playback. Default value: **xiaoyun**. For more information about the sound styles, see the **Sound styles** table below.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xiaoyun', - ], + 'schema' => ['description' => 'The outbound caller ID. You can specify a corporate trunk number or a custom outbound caller ID. This parameter is required when `ObClidType` is set to `2` or `3`.', 'type' => 'string', 'required' => false, 'example' => '22223333', 'title' => ''], ], [ - 'name' => 'TtsVolume', + 'name' => 'IsRandom', 'in' => 'query', - 'schema' => [ - 'description' => 'The volume of TTS variable playback. Valid values: 0 to 100. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to use a random caller ID. Valid values: `0` (No) and `1` (Yes). This parameter is required if `ObClidType` is set to `4`. The default value is `0` (No).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'TtsSpeed', + 'name' => 'IbRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'The speed of TTS variable playback. Valid values: -200 to 200. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'Specifies whether to enable inbound recording. Valid values: `0` (disabled) and `1` (enabled). The default value is `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'TtsConf', + 'name' => 'ObRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to set TTS sound parameters. Valid values:'."\n" - ."\n" - .'* **true**: TTS sound parameters must be set. You must set the **TtsStyle**, **TtsColume**, and **TtsSpeed** parameters to specify a sound style.'."\n" - .'* **false**: TTS sound parameters do not need to be set. The values of TTS sound parameters do not take effect even if you set them.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to enable outbound recording. Valid values: `0` (disabled) and `1` (enabled). The default value is `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AsrBaseId', + 'name' => 'IsAsr', 'in' => 'query', - 'schema' => [ - 'description' => 'The ASR base model. Valid values:'."\n" - ."\n" - .'* **customer_service\\_8k** (default): Chinese Mandarin.'."\n" - .'* **dialect_customer_service\\_8k**: a heavy accent.'."\n" - ."\n" - .'> You must specify the ASR model when you call the SmartCall operation. We recommend that you specify either of the AsrModelId and AsrBaseId parameters.'."\n" - ."\n" - .'* If you specify only the AsrModelId parameter, the specified ASR model is used.'."\n" - ."\n" - .'* If you specify only the AsrBaseId parameter, the ASR base model is used.'."\n" - ."\n" - .'* If you specify neither of the two parameters, the default ASR base model is used, that is, the default value customer_service\\_8k is used for the AsrBaseId parameter.'."\n" - ."\n" - .'* If you specify both parameters, make sure that their values do not conflict with each other.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'customer_service_8k', - ], + 'schema' => ['description' => 'Specifies whether to enable ASR transcription. Valid values: `0` (disabled) and `1` (enabled). The default value is `0` (disabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StreamAsr', + 'name' => 'IsQualityCheck', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable streaming ASR, which intelligently judges what the user wants to express based on the first few words spoken by the user. Valid values:'."\n" - ."\n" - .'* **0**: Streaming ASR is disabled.'."\n" - .'* **1**: Streaming ASR is enabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to enable agent quality check. Valid values: `0` (disabled) and `1` (enabled). The default value is `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'BackgroundFileCode', + 'name' => 'ObClidProperty', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the background voice file that is played back when the user talks with the robot.'."\n" - ."\n" - .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice File Management**, click the **Intelligent Speech Interaction Recording File** tab, and then click **Details** in the Actions column to view the voice ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', - ], + 'schema' => ['description' => 'The outbound caller ID properties, in URL-encoded JSON format. This parameter is used when `ObClidType` is set to `4`.
The JSON object contains the following fields:
`isMatchCapital`: Specifies whether to use a caller ID from a provincial capital. Valid values: `1` (Yes) and `0` (No).
`areaCodeRule`: The area code matching rule. Valid values: `1` (Use the agent\'s area code) and `2` (Use the customer\'s area code).


', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1}', 'title' => ''], ], [ - 'name' => 'BackgroundVolume', + 'name' => 'WebrtcUrlType', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '4', - 'minimum' => '-4', - 'example' => '1', - ], + 'schema' => ['description' => 'The type of endpoint address returned for the WebRTC softphone. Valid values: `0` (enterprise default), `1` (public domain), `2` (leased-line domain), `3` (public IP), and `4` (leased-line IP). The default value is `0` (enterprise default).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'BackgroundSpeed', + 'name' => 'IsObRemember', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is unavailable.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to enable outbound caller ID memory. Valid values: `0` (disabled) and `1` (enabled). The default value is `1` (enabled).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EnableITN', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable Inverse Text Normalization (ITN) during post-processing. Default value: **false**. If you set the value to false, ITN is not enabled during post-processing.'."\n" - ."\n" - .'If you set the value to **true**, Chinese numerals are converted into Arabic numerals for output.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The comment.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ - 'name' => 'NoiseThreshold', + 'name' => 'PermitObPreviewTime', 'in' => 'query', - 'schema' => [ - 'type' => 'number', - 'format' => 'double', - ], + 'schema' => ['description' => 'The outbound call time window. The value must be in the `HH:mm,HH:mm` format.', 'type' => 'string', 'required' => false, 'example' => '08:00,20:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - ], - 'CallId' => [ - 'description' => 'The unique receipt ID for this call.'."\n" - ."\n" - .'You can call the [QueryCallDetailByCallId](~~QueryCallDetailByCallId~~) operation to query the details of the call based on the receipt ID.'."\n", - 'type' => 'string', - 'example' => '116012854210^10281427****', + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'The number of agents that were successfully updated.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Fail' => ['description' => 'A list of agent IDs that failed to update.', 'type' => 'string', 'example' => 'null', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- A value of `OK` indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"CallId\\": \\"116012854210^10281427****\\"\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\nA90E4451-FED7-49D2-87C8-00700A8C4D0D\\n116012854210^10281427****\\nOK\\n","errorExample":""}]', - 'title' => 'SmartCall', - 'summary' => 'Initiates an intelligent voice call.', - 'description' => '* The SmartCall operation must be used together with the [intelligent outbound HTTP operation](~~112703~~). After the call initiated by the Voice Messaging Service (VMS) platform is connected, the VMS platform sends the text converted from speech back to the business side, and the business side then returns the follow-up action to the VMS platform.'."\n" - .'* The SmartCall operation does not support the following characters: `@ = : "" $ { } ^ * ￥`.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 1,000 times per second per account.'."\n", - 'requestParamsDescription' => '### Sound styles'."\n" - ."\n" - .'|Description|Code|'."\n" - .'|---|---|'."\n" - .'|Xiaoyun (standard female voice)|xiaoyun|'."\n" - .'|Xiaogang (standard male voice)|xiaogang|'."\n" - .'|Ruoxi (gentle female voice)|ruoxi|'."\n" - .'|Xiaomeng (standard female voice)|xiaomeng|'."\n" - .'|Xiaowei (standard male voice)|xiaowei|'."\n" - .'|Amei (sweet female voice)|amei|'."\n" - .'|Xiaoxue (gentle female voice)|xiaoxue|'."\n" - .'|Siqi (gentle female voice)|siqi|'."\n" - .'|Sijia (standard female voice)|sijia|'."\n" - .'|Sicheng (standard male voice)|sicheng|'."\n" - .'|Siyue (gentle female voice)|siyue|'."\n" - .'|Xiaomei (sweet female voice)|xiaomei|'."\n" - .'|Sitong (standard children\'s voice)|sitong|'."\n" - .'|Ninger (standard female voice)|ninger|'."\n" - .'|Xiaobei (Lolita female voice)|xiaobei|'."\n" - .'|Yina (female voice with Zhejiang accent)|yina|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SmartCallOperate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudBatchUpdateAgent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Success\\": \\"3\\",\\n \\"Fail\\": \\"null\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateAgent' => [ + 'summary' => 'Create an agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52714', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique receipt ID of the call. You can call the [SmartCall](~~393526~~) operation to obtain the receipt ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '116012854210^1028142****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'Command', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => 'The action that is initiated to the called number of an outbound robocall.'."\n" - ."\n" - .'> Only the value **parallelBridge** is supported. This value indicates that a bridge action is initiated between a called number and an agent of the call center.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'parallelBridge', - ], + 'schema' => ['description' => 'The agent ID. It must be a 3- to 10-digit positive integer.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], [ - 'name' => 'Param', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Param', - ], + 'schema' => ['description' => 'The agent name. The name must be URL-encoded in UTF-8.', 'type' => 'string', 'required' => true, 'example' => '张三', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The action result. Valid values:'."\n" - ."\n" - .'* **true**: The action was successful.'."\n" - .'* **false**: The action failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - ], - ], - ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s area code.', 'type' => 'string', 'required' => true, 'example' => '010', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\tOK\\r\\n\\tOK\\r\\n\\tA90E4451-FED7-49D2-87C8-00700A8C4D0D\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'SmartCallOperate', - 'summary' => 'Initiates an action in an outbound robocall. This operation is applicable only when the robocall is transferred to an agent or an agent is listening in on the conversation between the robot and the user.', - 'description' => 'You can call this operation to initiate a specified action on the called number of an outbound robocall when the call is transferred to an agent of the call center.'."\n" - ."\n" - .'> You can only initiate the action of bridging a called number and an agent of the call center.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['description' => 'Determines if the agent is active. Valid values: `1` (active) and `0` (inactive). The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], - 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'Power', 'in' => 'query', - 'schema' => [ - 'description' => 'The task name. The task name can be up to 30 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test Template', - ], + 'schema' => ['description' => 'The agent\'s permission level. Valid values: `1` (supervisor) and `0` (agent). The default is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'DialogId', + 'name' => 'CallPower', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the robot or communication script that is used to initiate the call.'."\n" - ."\n" - .'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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000023****', - ], + 'schema' => ['description' => 'The agent\'s calling permission. Valid values: `0` (unlimited), `1` (domestic long distance), `2` (local), and `3` (internal calls). The default is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'CorpName', + 'name' => 'Wrapup', 'in' => 'query', - 'schema' => [ - 'description' => 'The company name, which must be the same as the **enterprise name** on the qualification management page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alibaba', - ], + 'schema' => ['description' => 'The wrap-up time in seconds. The default is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Caller', + 'name' => 'IsOb', 'in' => 'query', - 'schema' => [ - 'description' => 'The calling number.'."\n" - ."\n" - .'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.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0571****5678', - ], + 'schema' => ['description' => 'Determines if the agent can make outbound calls. Valid values: `1` (allowed) and `0` (not allowed). The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NumberStatusIdent', + 'name' => 'ObClidType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable number status identification. Valid values:'."\n" - ."\n" - .'* **false** (default)'."\n" - .'* **true**'."\n" - ."\n" - .'> If you set this parameter to **true**, the reason why a call is not answered is recorded.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The caller ID rule. Valid values: `1` (default), `2` (random), `3` (by area code), and `4` (dynamic caller ID). The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RetryType', + 'name' => 'ObClid', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable auto-redial. Valid values:'."\n" - ."\n" - .'* **1**: enables auto-redial.'."\n" - .'* **0**: disables auto-redial.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The pass-through number. This can be an enterprise trunk number or a pre-configured caller ID number. This parameter is required if `ObClidType` is set to `2` or `3`.', 'type' => 'string', 'required' => false, 'example' => '22223333', 'title' => ''], ], [ - 'name' => 'RecallStateCodes', + 'name' => 'ObClidProperty', 'in' => 'query', - 'schema' => [ - 'description' => 'The call state in which redial is required. Separate multiple call states with commas (,). Valid values:'."\n" - ."\n" - .'* **200010**: The phone of the called party is powered off.'."\n" - .'* **200011**: The number of the called party is out of service.'."\n" - .'* **200002**: The line is busy.'."\n" - .'* **200012**: The call is lost.'."\n" - .'* **200005**: The called party cannot be connected.'."\n" - .'* **200003**: The called party does not respond to the call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200010,200011', - ], + 'schema' => ['description' => 'The caller ID properties, specified as a JSON string. This parameter is required if `ObClidType` is set to `4`. The JSON string can contain the following fields: `isMatchCapital` determines if phone numbers of provincial capitals are matched (`1`: yes, `0`: no); `areaCodeRule` sets the area code matching rule (`1`: agent area code, `2`: customer\'s area code); and `isRandom` enables a random caller ID (`1`: yes).', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}', 'title' => ''], ], [ - 'name' => 'RecallTimes', + 'name' => 'IbRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of redial times.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Determines if inbound calls are recorded. Valid values: `1` (record) and `0` (do not record). The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RecallInterval', + 'name' => 'ObRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'The redial interval. Unit: minutes. The value must be greater than 1.'."\n" - ."\n" - .'> The maximum redial interval is 30 minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'Determines if outbound calls are recorded. Valid values: `1` (record) and `0` (do not record). The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'IsSelfLine', + 'name' => 'SkillIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to call the self-managed line. Valid values:'."\n" - ."\n" - .'* **false** (default)'."\n" - .'* **true**'."\n" - ."\n" - .'> If you set this parameter to **true**, calling numbers are not verified.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The IDs of skills assigned to the agent, separated by commas (,). If this parameter is set, you must also specify `SkillLevels`.', 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], + ], + [ + 'name' => 'SkillLevels', + 'in' => 'query', + 'schema' => ['description' => 'The proficiency level for each skill in `SkillIds`, separated by commas (,). The levels must correspond to the skill IDs in order. A smaller value indicates a higher proficiency level. For example, if `SkillIds` is "1,2,3" and `SkillLevels` is "5,1,1", the agent\'s proficiency for skill 1 is 5, for skill 2 is 1, and for skill 3 is 1.', 'type' => 'string', 'required' => false, 'example' => '5,1,1', 'title' => ''], + ], + [ + 'name' => 'IsAsr', + 'in' => 'query', + 'schema' => ['description' => 'Determines if ASR transcription is enabled. Valid values: `1` (enabled) and `0` (disabled). The default is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IsQualityCheck', + 'in' => 'query', + 'schema' => ['description' => 'Determines if agent quality inspection is enabled. Valid values: `1` (enabled) and `0` (disabled). The default is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'WebrtcUrlType', + 'in' => 'query', + 'schema' => ['description' => 'The type of URL to return for the WebRTC softphone. Valid values: `0` (enterprise default), `1` (public domain name), `2` (private line domain name), `3` (public IP), and `4` (private line IP).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IsObRemember', + 'in' => 'query', + 'schema' => ['description' => 'Determines if outbound caller ID memory is enabled. Valid values: `1` (enabled) and `0` (disabled). The default is `1`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'An optional comment about the agent.', 'type' => 'string', 'required' => false, 'example' => '备注', 'title' => ''], + ], + [ + 'name' => 'PermitObPreviewTime', + 'in' => 'query', + 'schema' => ['description' => 'The time period when outbound calls are permitted, specified in `HH:mm,HH:mm` format.', 'type' => 'string', 'required' => false, 'example' => '08:00,20:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The unique ID of the robocall task.'."\n" - ."\n" - .'You can call the [QueryRobotTaskDetail](~~393538~~) operation to query the details of the task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '400111****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'Agent' => [ + 'description' => 'The agent configuration.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The agent status. Valid values: `0` (Offline) and `1` (Online).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IsQualityCheck' => ['description' => 'Specifies whether quality inspection is enabled for the agent. Valid values: `0` (Disabled) and `1` (Enabled). Default value: `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CallPower' => ['description' => 'The calling permission. Valid values: `0` (Unlimited), `1` (Domestic long distance), `2` (Local), and `3` (Internal). Default value: `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ObClid' => ['description' => 'The caller ID.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'Cno' => ['description' => 'The agent\'s work ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the agent was created, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-01-30 08:00:00', 'title' => ''], + 'IbRecord' => ['description' => 'Specifies whether inbound calls are recorded. Valid values: `0` (Do not record) and `1` (Record). Default value: `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'BindTelType' => ['description' => 'The phone type. Valid values: `1` (Landline), `2` (Mobile), `3` (Extension), and `4` (softphone).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Wrapup' => ['description' => 'The wrap-up time, in seconds. Default value: 10.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ObRecord' => ['description' => 'Specifies whether outbound calls are recorded. Valid values: `0` (Do not record) and `1` (Record). Default value: `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'IsAsr' => ['description' => 'Specifies whether ASR transcription is enabled. Valid values: `0` (Disabled) and `1` (Enabled). Default value: `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Active' => ['description' => 'Specifies whether the agent is enabled. Valid values: `0` (Disabled) and `1` (Enabled). Default value: `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObClidType' => ['description' => 'The caller ID rule. Valid values: `1` (Enterprise default), `2` (Random), `3` (By area code), and `4` (Dynamic).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'WebrtcUrlType' => ['description' => 'The type of URL returned for the WebRTC softphone. Valid values: `0` (Enterprise default), `1` (public network domain), `2` (leased line domain), `3` (public network IP), and `4` (leased line IP).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'ObClidProperty' => ['description' => 'The properties of the caller ID rule, in JSON format.', 'type' => 'string', 'example' => '{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}', 'title' => ''], + 'BindTel' => ['description' => 'The phone number bound to the agent.', 'type' => 'string', 'example' => '2222333', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the agent.', 'type' => 'string', 'example' => '355', 'title' => ''], + 'Power' => ['description' => 'The agent role. Valid values: `1` (supervisor) and `0` (agent). Default value: `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IsOb' => ['description' => 'Specifies whether the agent can make outbound calls. Valid values: `0` (Not allowed) and `1` (Allowed). Default value: `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'AgentSkills' => [ + 'description' => 'An array of agent skills.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Cno' => ['description' => 'The agent\'s work ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the skill was assigned, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-01-30 08:00:00', 'title' => ''], + 'SkillId' => ['description' => 'The skill ID.', 'type' => 'string', 'example' => '233', 'title' => ''], + 'Id' => ['description' => 'The unique ID for the agent-skill assignment.', 'type' => 'string', 'example' => '355', 'title' => ''], + 'AgentId' => ['description' => 'The unique ID of the agent.', 'type' => 'string', 'example' => '2333', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code. `OK` indicates a successful request. For more information about other error codes, see Error codes.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"400111****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', - 'title' => 'CreateRobotTask', - 'summary' => 'Initiates an outbound robocall task.', - 'description' => 'You can call this operation to initiate an outbound robocall task by using the robot communication scripts preset in the Voice Messaging Service console. 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.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchRobotSmartCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateAgent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Agent\\": {\\n \\"Status\\": \\"0\\",\\n \\"IsQualityCheck\\": \\"1\\",\\n \\"CallPower\\": \\"0\\",\\n \\"ObClid\\": \\"xxxxxxxx\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-01-30 08:00:00\\",\\n \\"IbRecord\\": \\"1\\",\\n \\"BindTelType\\": \\"1\\",\\n \\"Wrapup\\": \\"10\\",\\n \\"ObRecord\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"张三\\",\\n \\"IsAsr\\": \\"0\\",\\n \\"Active\\": \\"1\\",\\n \\"ObClidType\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"0\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"ObClidProperty\\": \\"{\\\\\\"isMatchCapital\\\\\\":0,\\\\\\"areaCodeRule\\\\\\":1,\\\\\\"isRandom\\\\\\":1}\\",\\n \\"BindTel\\": \\"2222333\\",\\n \\"Id\\": \\"355\\",\\n \\"Power\\": \\"0\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"AgentSkills\\": [\\n {\\n \\"SkillLevel\\": \\"2\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-01-30 08:00:00\\",\\n \\"SkillId\\": \\"233\\",\\n \\"Id\\": \\"355\\",\\n \\"AgentId\\": \\"2333\\",\\n \\"EnterpriseId\\": \\"7000002\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateAgentGroup' => [ + 'summary' => 'Use this operation to create an agent group.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number displayed to called parties, which must be a number you purchased. You can view the numbers you purchased in the [Voice Messaging Service console](https://dyvms.console.aliyun.com/dyvms.htm#/number/normal).'."\n" - ."\n" - .'You can set up to 100 numbers and separate the numbers with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '222', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CorpName', + 'name' => 'Gno', 'in' => 'query', - 'schema' => [ - 'description' => 'The company name, which must be the same as the **company name** specified on the [qualification management page](https://dyvms.console.aliyun.com/dyvms.htm#/corp/normal).'."\n" - ."\n" - .'> This parameter is optional if **isSelfLine** is set to **true**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alibaba', - ], + 'schema' => ['description' => 'The outbound group number, which must be unique within an enterprise. The number must be 2 to 20 characters long, start with a letter, and contain only letters and digits. An enterprise can have a maximum of 1,000 agent groups.', 'type' => 'string', 'required' => true, 'example' => 'WH12', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The called number. Only mobile phone numbers in the Chinese mainland are supported.'."\n" - ."\n" - .'You can set up to 1,000 called numbers and separate the numbers with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1390000****', - ], + 'schema' => ['description' => 'The outbound group name. The name cannot be empty, must not exceed 50 characters, and must be URL-encoded in UTF-8.', 'type' => 'string', 'required' => true, 'example' => 'gpname1', 'title' => ''], ], [ - 'name' => 'DialogId', + 'name' => 'Comment', 'in' => 'query', + 'schema' => ['description' => 'The description. The value can be up to 100 characters long and must be URL-encoded in UTF-8.', 'type' => 'string', 'required' => false, 'example' => 'comment3', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the robot or communication script that is used to initiate a call.'."\n" - ."\n" - .'You can obtain the **communication script ID** from the [Communication script management](https://dyvms.console.aliyun.com/dyvms.htm#/smart-call/saas/robot/list) page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1234567', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'A deprecated parameter. You can ignore it.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The outbound group name.', 'type' => 'string', 'example' => 'gpname1', 'title' => ''], + 'Comment' => ['description' => 'The description.', 'type' => 'string', 'example' => 'comment3', 'title' => ''], + 'Type' => ['description' => 'The type of the agent group. Valid values: `1` for the main agent group and `2` for a regular agent group.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the agent group, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'Gno' => ['description' => 'The outbound group number.', 'type' => 'string', 'example' => 'WH12', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => 'The response body.', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateAgentGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"gpname1\\",\\n \\"Comment\\": \\"comment3\\",\\n \\"Type\\": 2,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Gno\\": \\"WH12\\",\\n \\"EnterpriseId\\": 7000002\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateAsr' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EarlyMediaAsr', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The speech recognition identifier of early media. The default value is **false**, which means that the speech recognition identifier of early media is not enabled.'."\n" - ."\n" - .'Set the parameter to **true** if you want to enable the speech recognition identifier of early media.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'CallType', 'in' => 'query', - 'schema' => [ - 'description' => 'The task name. The task name can be up to 30 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Batch Tasks', - ], + 'schema' => ['description' => 'The call type. Valid values: `1` (inbound call), `2` (webcall), `4` (preview outbound call), `5` (predictive outbound call), `6` (agent-initiated outbound call), and `9` (internal call).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'ScheduleTime', + 'name' => 'RecordFile', 'in' => 'query', - 'schema' => [ - 'description' => 'The preset call time. This value is a UNIX timestamp. Unit: milliseconds.'."\n" - ."\n" - .'> This parameter is required only when **ScheduleCall** is set to **true**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['description' => 'The recording file name. Example: `7000002-20170320140327-1581-1500-record-sip-2-148998.366`', 'type' => 'string', 'required' => true, 'example' => ' 7000002-20170320140327-1581-1500-record-sip-2-148998.366', 'title' => ''], ], [ - 'name' => 'ScheduleCall', + 'name' => 'RecordType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the call is scheduled. If you set this parameter to **true**, the **ScheduleTime** parameter is required.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The audio file type. Valid values: `record` (recording) and `voicemail`.', 'type' => 'string', 'required' => true, 'example' => 'record', 'title' => ''], ], [ - 'name' => 'TtsParam', + 'name' => 'RecordSide', 'in' => 'query', - 'schema' => [ - 'description' => 'The variable value of the TTS template, in the JSON format.'."\n" - ."\n" - .'The variable value must correspond to a number. The TtsParam parameter must be used together with the TtsParamHead parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"number":"1390000****","params":[“Miss li”,"miss wang","Mr.li"]}]', - ], + 'schema' => ['description' => 'The recording channel type. Valid values for track-based recording: `0` (mixed audio), `1` (customer side), `2` (agent side), and `3` (both the customer and agent sides).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'TtsParamHead', + 'name' => 'UniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The call tasks with variables, in the JSON format.'."\n" - ."\n" - .'The parameter value is a list of variable names. The TtsParamHead parameter must be used together with the TtsParam parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["name1","name2","name3"]', - ], + 'schema' => ['description' => 'The unique ID of the sub-channel.', 'type' => 'string', 'required' => true, 'example' => 'sip-2-1489989807.36601', 'title' => ''], ], [ - 'name' => 'IsSelfLine', + 'name' => 'MainUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to call the self-managed line. Default value: **false**.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The unique ID of the main channel.', 'type' => 'string', 'required' => true, 'example' => 'sip-2-1489989807.36601', 'title' => ''], + ], + [ + 'name' => 'SupportMp3', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use an MP3 file for transcription if the corresponding WAV file has expired. Valid values: `0` (No, default) and `1` (Yes). If you set this parameter to `1`, the system automatically uses the MP3 file for transcription when the WAV file is unavailable. In this case, the recording channel type in the result is set to `mixed audio`. Note that a mixed-audio MP3 file cannot separate the two speakers, while a dual-channel MP3 file can.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'TaskId' => [ - 'description' => 'The unique ID of the robocall task. You can call the [QueryCallDetailByTaskId](~~393537~~) operation to query the details of the task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '4001112222', + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"TaskId\\": \\"4001112222\\"\\n}","type":"json"}]', - 'title' => 'BatchRobotSmartCall', - 'summary' => 'Initiates outbound robocall tasks in a batch. You can set up to 100 numbers in a task.', - 'description' => '* 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.'."\n" - .'* The BatchRobotSmartCall operation is used to initiate an outbound robocall task by using the robot communication scripts preset in the Voice Messaging Service console.'."\n" - ."\n" - .'## Prerequisites'."\n" - ."\n" - .'* You have passed the real-name verification for an enterprise user and passed the enterprise qualification review.'."\n" - .'* You have purchased numbers in the [Voice Messaging Service console](https://dyvms.console.aliyun.com/dyvms.htm#/number/normal).'."\n" - .'* You have added communication scripts on the [Communication script management](https://dyvms.console.aliyun.com/dyvms.htm#/smart-call/saas/robot/list) page, and the communication scripts have been approved.'."\n" - ."\n" - .'> Before you call this operation, make sure that you are familiar with the [billing](https://www.aliyun.com/price/product#/vms/detail) of Voice Messaging Service (VMS).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StartRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateAsr', + 'summary' => 'Creates an Automatic Speech Recognition (ASR) transcription task from a recording file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateEnterpriseTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '104500****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'ScheduleTime', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The time scheduled for starting the robocall task, in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-06-14 14:55:23', - ], + 'schema' => ['description' => 'The name of the time condition. The name must be unique within the same call center.', 'type' => 'string', 'required' => true, 'example' => 'demo01', 'title' => ''], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => ['description' => 'The priority of the time condition. The priority must be unique within the same call center. The minimum value is 1. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The condition type. Valid values: `1` (By day of the week) and `2` (By a fixed date range).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'TimeType', + 'in' => 'query', + 'schema' => ['description' => 'The time type. Valid values: `1` (Continuous) and `2` (Interval).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'FromDay', + 'in' => 'query', + 'schema' => ['description' => 'The start date. This parameter is required when `Type` is set to `2`. The value must be in the `YYYY-MM-DD` format. If `Type` is set to `1`, pass an empty string. The value of `FromDay` cannot be later than the value of `ToDay`.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20', 'title' => ''], + ], + [ + 'name' => 'ToDay', + 'in' => 'query', + 'schema' => ['description' => 'The end date. This parameter is required when `Type` is set to `2`. The value must be in the `YYYY-MM-DD` format. If `Type` is set to `1`, pass an empty string. The value of `ToDay` cannot be earlier than the value of `FromDay`.', 'type' => 'string', 'required' => false, 'example' => '2026-04-25', 'title' => ''], + ], + [ + 'name' => 'DayOfWeek', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is required when `Type` is set to `1`. Specifies the days of the week. Valid values: Monday=`2`, Tuesday=`3`, Wednesday=`4`, Thursday=`5`, Friday=`6`, Saturday=`7`, and Sunday=`1`. Separate multiple values with commas (,), for example, `2,3,4`. If `Type` is set to `2`, pass an empty string.', 'type' => 'string', 'required' => false, 'example' => '2,3,4', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time in the `HH:mm` format. For example, `06:00`. The value of `StartTime` cannot be later than the value of `EndTime`.', 'type' => 'string', 'required' => true, 'example' => '06:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time in the `HH:mm` format. For example, `19:00`. The value of `EndTime` cannot be earlier than the value of `StartTime`.', 'type' => 'string', 'required' => true, 'example' => '19:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This is a deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**: The request was successful.'."\n" - .'* **false**: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 2 (Monday), 3 (Tuesday), 4 (Wednesday), 5 (Thursday), 6 (Friday), 7 (Saturday), and 1 (Sunday). Commas (,) separate multiple values. This parameter is an empty string if `Type` is set to 2.', 'type' => 'string', 'example' => '2,3,4', 'title' => ''], + 'Type' => ['description' => 'The type of the time condition. Valid values: 1 (by week) and 2 (by fixed date range).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ToDay' => ['description' => 'The end date in YYYY-MM-DD format. This parameter is an empty string if `Type` is 1. This value must be on or after the date specified in `FromDay`.', 'type' => 'string', 'example' => '2026-04-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time in HH:mm format. This value must be the same as or later than the time specified in `StartTime`.', 'type' => 'string', 'example' => '19:00'."\n", 'title' => ''], + 'Priority' => ['description' => 'The priority of the time condition. The priority must be unique within the same call center. The value starts from 1, and a smaller value indicates a higher priority.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the time condition, in YYYY-MM-DD HH:mm:ss format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The start time in HH:mm format. This value must be the same as or earlier than the time specified in `EndTime`.', 'type' => 'string', 'example' => '06:00'."\n", 'title' => ''], + 'FromDay' => ['description' => 'The start date in YYYY-MM-DD format. This parameter is an empty string if `Type` is 1. This value must be on or before the date specified in `ToDay`.', 'type' => 'string', 'example' => '2026-04-20', 'title' => ''], + 'Id' => ['description' => 'The ID of the time condition.', 'type' => 'string', 'example' => '236', 'title' => ''], + 'EnterpriseId' => ['description' => 'The ID of the call center.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The name of the time condition. The name must be unique within the same call center.', 'type' => 'string', 'example' => 'demo01', 'title' => ''], + 'TimeType' => ['description' => 'The time type. Valid values: 1 (Continuous) and 2 (Interval).', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code. A value of "OK" indicates a successful request.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\ttrue\\n","errorExample":""}]', - 'title' => 'StartRobotTask', - 'summary' => 'Starts a robocall task immediately or at a scheduled time.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StopRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateEnterpriseTime', + 'summary' => 'Creates a time condition configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"DayOfWeek\\": \\"2,3,4\\",\\n \\"Type\\": \\"1\\",\\n \\"ToDay\\": \\"2026-04-25\\",\\n \\"EndTime\\": \\"19:00\\\\n\\",\\n \\"Priority\\": \\"1\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"StartTime\\": \\"06:00\\\\n\\",\\n \\"FromDay\\": \\"2026-04-20\\",\\n \\"Id\\": \\"236\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"demo01\\",\\n \\"TimeType\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateExten' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['description' => 'The contact center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Exten', + 'in' => 'query', + 'schema' => ['description' => 'The extension number. Must be 3 to 11 digits.', 'type' => 'string', 'required' => true, 'example' => '9000', 'title' => ''], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => 'The password for the extension.', 'type' => 'string', 'required' => true, 'example' => 'Aa248236', 'title' => ''], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the calling permission. Valid values: `0` (Unlimited), `1` (National long-distance), `2` (Local), and `3` (Internal calls only). The default value is `0`.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allow outbound calls. Valid values: `0` (disabled) and `1` (enabled). The default value is `1`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IsDirect', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allow off-hook dialing. Valid values: `0` (disabled) and `1` (enabled). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to record inbound calls. Valid values: `0` (disabled) and `1` (enabled). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to record outbound calls. Valid values: `0` (disabled) and `1` (enabled). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the area code for the extension.', 'type' => 'string', 'required' => true, 'example' => '010', 'title' => ''], + ], + [ + 'name' => 'JitterBuffer', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the jitter buffer. Valid values: `0` (disabled) and `1` (enabled). The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the registration type for the extension. Valid values: `1` (IAD gateway), `2` (softphone), and `3` (remote phone).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Allow', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the codec configuration by its ID.
Valid values:
`1`: `g729`
`2`: `g729, alaw, ulaw`
`3`: `alaw, ulaw, g729`
`4`: `alaw, ulaw`
`5`: `myopus, alaw, ulaw`
`6`: `myopus, g729, alaw, ulaw`
`7`: `myopus, g729`
The supported configuration depends on the endpoint and network:
- **Remote phone + public network**: `1`, `2`, or `3`
- **Remote phone + leased line**: `1` or `2`
- **Softphone + public network**: `4`
- **Softphone + leased line**: `5`












', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IadName', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the name of the IAD gateway. This parameter applies only when `Type` is set to `1`.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], + [ + 'name' => 'Property', + 'in' => 'query', + 'schema' => ['description' => 'Specifies custom properties for the extension in a JSON-formatted string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'Denoise', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable noise reduction. Valid values: `0` (disabled) and `1` (enabled). This parameter applies only when `Type` is set to `2`.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated. Please ignore it.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**: The request was successful.'."\n" - .'* **false**: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'CallPower' => ['description' => 'The calling permission. Valid values: `0` (Unlimited), `1` (Domestic Long Distance), `2` (Domestic Local), and `3` (Internal Call). The default value is `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-03-30 06:09:04', 'title' => ''], + 'IbRecord' => ['description' => 'Specifies whether inbound call recording is enabled. Valid values: `0` (disabled) and `1` (enabled). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Exten' => ['description' => 'The extension. Length: 3 to 11 digits.', 'type' => 'string', 'example' => '9000', 'title' => ''], + 'ObRecord' => ['description' => 'Specifies whether outbound call recording is enabled. Valid values: `0` (disabled) and `1` (enabled). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'BindGatewayId' => ['description' => 'The ID of the bound agent-gateway.', 'type' => 'integer', 'format' => 'int64', 'example' => '28', 'title' => ''], + 'Allow' => ['description' => 'The audio codec.', 'type' => 'string', 'example' => 'alaw,ulaw', 'title' => ''], + 'Type' => ['description' => 'The registration target. Valid values: `1` (IAD extension), `2` (WebRTC), and `3` (remote phone).', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'Denoise' => ['description' => 'Specifies whether noise reduction is enabled. Valid values: `0` (disabled) and `1` (enabled). The default value is `0`. This parameter is valid only when the `Type` parameter is set to `2`.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The extension ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '336450', 'title' => ''], + 'IsDirect' => ['description' => 'Specifies whether off-hook outbound calls are allowed. Valid values: `0` (disallowed) and `1` (allowed). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => 'Aa248236', 'title' => ''], + 'IsOb' => ['description' => 'Specifies whether outbound calls are allowed. Valid values: `0` (disallowed) and `1` (allowed). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\ttrue\\n","errorExample":""}]', - 'title' => 'StopRobotTask', - 'summary' => 'Stops a robocall task that is in progress.', - 'description' => 'After you stop a robocall task, you can call the [StartRobotTask](~~StartRobotTask~~) operation to start it again.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CancelOrderRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateExten', + 'summary' => 'This operation creates an extension.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"CallPower\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-03-30 06:09:04\\",\\n \\"IbRecord\\": 1,\\n \\"Exten\\": \\"9000\\",\\n \\"ObRecord\\": 1,\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"BindGatewayId\\": 28,\\n \\"Allow\\": \\"alaw,ulaw\\",\\n \\"Type\\": 2,\\n \\"AreaCode\\": \\"010\\",\\n \\"Denoise\\": 0,\\n \\"Id\\": 336450,\\n \\"IsDirect\\": 1,\\n \\"Password\\": \\"Aa248236\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateQueue' => [ + 'summary' => 'Call this API to create a queue.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Queue', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the ID of the robocall task.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The configuration details of the queue.', + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['description' => 'The service level threshold in seconds. Calls answered within this time meet the service level target.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], + 'AnnounceSound' => ['description' => 'Specifies whether to play a fixed announcement. Valid values:
• 0: Off
• 1: On

', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], + 'WrapupTime' => ['description' => 'The wrap-up time, in seconds. Valid range: 3 to 3,600.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30', 'title' => ''], + 'MaxLen' => ['description' => 'The maximum number of callers that can wait in the queue. The valid range is 0 to 999. A value of 0 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The name of the queue.', 'type' => 'string', 'required' => true, 'example' => 'queueName', 'title' => ''], + 'AnnouncePosition' => ['description' => 'Specifies the condition for announcing a caller\'s position in the queue. Valid values:
• 0: Off
• 1: Announce when the position is greater than the `AnnouncePositionParam` value.
• 2: Announce when the position is less than or equal to the `AnnouncePositionParam` value.


', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'AnnounceSoundFile' => ['description' => 'The audio file for the fixed announcement.', 'type' => 'string', 'required' => false, 'example' => 'announceSoundFile3', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the queue was created. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'QueueTimeout' => ['description' => 'The queue timeout period in seconds. The value must be between 20 and 600. The default value is 600.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '80', 'title' => ''], + 'AnnounceSoundFrequency' => ['description' => 'The interval, in seconds, at which the fixed announcement is played.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'AnnouncePositionYouarenext' => ['description' => 'Specifies whether to enable the "You are next in line" announcement.
• 0: Off
• 1: On

', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'AnnouncePositionParam' => ['description' => 'The threshold for the position announcement, used with the `AnnouncePosition` parameter. The value must be greater than or equal to 2.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + 'MemberTimeout' => ['description' => 'The time in seconds an agent has to answer a call before it is rerouted.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25', 'title' => ''], + 'Weight' => ['description' => 'The queue priority. The value must be between 1 and 10. A higher value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8', 'title' => ''], + 'JoinEmpty' => ['description' => 'A bitmask that defines which agent statuses are considered unavailable for routing when a call enters an empty queue. Valid statuses:
• 1: Busy
• 2: In a call
• 4: Ringing
• 8: Invalid
• 16: Wrap-up




', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'Qno' => ['description' => 'The queue number.', 'type' => 'string', 'required' => true, 'example' => '3003', 'title' => ''], + 'MusicClass' => ['description' => 'The music-on-hold class.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], + 'Strategy' => ['description' => 'The call strategy used to route calls to agents. Valid values:
• `rrordered`: Skill Priority
• `rrmemory`: Round-robin
• `fewestcalls`: Fewest Calls
• `random`: Random
• `linear`: Linear
• `leastrecent`: Longest Idle





', 'type' => 'string', 'required' => true, 'example' => 'rrordered', 'title' => ''], + 'Retry' => ['description' => 'The delay, in seconds, to wait before trying the next agent if the current one does not answer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5', 'title' => ''], + 'SayAgentno' => ['description' => 'Enables or disables the agent number announcement. Valid values:
• true: Announce
• false: Do not announce

', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + 'VipSupport' => ['description' => 'Enables or disables VIP support for the queue. Valid values:
• 1: Enabled
• 0: Disabled

', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'AnnouncePositionFrequency' => ['description' => 'The interval, in seconds, at which the caller\'s position in the queue is announced.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], 'required' => true, - 'docRequired' => true, - 'example' => '1045001', + 'example' => '', + 'title' => '', + ], + ], + [ + 'name' => 'QueueSkills', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The skills associated with the queue.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], + 'SkillId' => ['description' => 'The ID of the skill.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '66', 'title' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**: The request was successful.'."\n" - .'* **false**: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'QueueSkills' => [ + 'description' => 'An array of skills for the queue.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the skill was associated with the queue. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'QueueId' => ['description' => 'The queue ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '51937', 'title' => ''], + 'SkillId' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '48734', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the association between the queue and the skill.', 'type' => 'integer', 'format' => 'int64', 'example' => '54474', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'Queue' => [ + 'description' => 'The configuration details of the queue.', + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['description' => 'The service level threshold in seconds. Calls that are answered within this period are considered to have a high service level.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'AnnounceSound' => ['description' => 'Specifies whether to play a fixed audio. Valid values: 0: disables the feature. 1: enables the feature.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'WrapupTime' => ['description' => 'The wrap-up time. Unit: seconds. Valid values: 3 to 3600.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'MaxLen' => ['description' => 'The maximum number of callers that can wait in the queue. Valid values: 0 to 999. The value 0 indicates that no limit is imposed.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'queueName', 'title' => ''], + 'AnnouncePosition' => ['description' => 'The condition for announcing the caller\'s position in the queue. Valid values: 0: disables the feature. 1: announces the position when it is greater than the value of the AnnouncePositionParam parameter. 2: announces the position when it is less than or equal to the value of the AnnouncePositionParam parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnounceSoundFile' => ['description' => 'The fixed audio file.', 'type' => 'string', 'example' => 'sound_file3', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the queue was created. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'QueueTimeout' => ['description' => 'The timeout period for the queue. Unit: seconds. Valid values: 5 to 600. Default value: 600.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'AnnounceSoundFrequency' => ['description' => 'The interval at which the fixed audio is played. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionYouarenext' => ['description' => 'Specifies whether to announce "You are the next in line." Valid values: 0: disables the announcement. 1: enables the announcement.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionParam' => ['description' => 'The threshold for announcing the caller\'s position.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'MemberTimeout' => ['description' => 'The timeout period for an agent to answer a call. Unit: seconds. Valid values: 20 to 60. Default value: 25.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'Weight' => ['description' => 'The priority of the queue. Valid values: 1 to 10. A larger value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'JoinEmpty' => ['description' => 'Specifies whether a call can be routed to an empty queue. Valid values: 1: The agent is busy. 2: The agent is on a call. 4: The agent\'s phone is ringing. 8: The agent\'s status is invalid. 16: The agent is in the wrap-up state.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + 'Qno' => ['description' => 'The queue number.', 'type' => 'string', 'example' => '12331', 'title' => ''], + 'MusicClass' => ['description' => 'The hold music class.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Strategy' => ['description' => 'The call routing strategy. Valid values: `rrordered`: skill-based priority. `rrmemory`: round-robin. `fewestcalls`: average call volume. `random`: random. `linear`: sequential. `leastrecent`: longest idle time.', 'type' => 'string', 'example' => 'rrordered', 'title' => ''], + 'Id' => ['description' => 'The queue ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'Retry' => ['description' => 'The interval at which a call is routed to the next agent if the current agent does not answer. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'SayAgentno' => ['description' => 'Specifies whether to announce the agent ID. Valid values: true: announces the agent ID. false: does not announce the agent ID.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VipSupport' => ['description' => 'Specifies whether to support VIP callers. Valid values: 1: yes. 0: no.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionFrequency' => ['description' => 'The interval at which the caller\'s position in the queue is announced. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\ttrue\\n","errorExample":""}]', - 'title' => 'CancelOrderRobotTask', - 'summary' => 'Cancels a robocall task that has not been started.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CancelRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateQueue', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"QueueSkills\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueId\\": 51937,\\n \\"SkillId\\": 48734,\\n \\"Id\\": 54474,\\n \\"EnterpriseId\\": 7000002\\n }\\n ],\\n \\"Queue\\": {\\n \\"ServiceLevel\\": 10,\\n \\"AnnounceSound\\": 0,\\n \\"WrapupTime\\": 30,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queueName\\",\\n \\"AnnouncePosition\\": 0,\\n \\"AnnounceSoundFile\\": \\"sound_file3\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueTimeout\\": 60,\\n \\"AnnounceSoundFrequency\\": 0,\\n \\"AnnouncePositionYouarenext\\": 0,\\n \\"AnnouncePositionParam\\": 2,\\n \\"MemberTimeout\\": 25,\\n \\"Weight\\": 10,\\n \\"JoinEmpty\\": 1,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"12331\\",\\n \\"MusicClass\\": \\"default\\",\\n \\"Strategy\\": \\"rrordered\\",\\n \\"Id\\": 80,\\n \\"Retry\\": 5,\\n \\"SayAgentno\\": false,\\n \\"VipSupport\\": 0,\\n \\"AnnouncePositionFrequency\\": 10\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateQueueSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['description' => 'The queue number.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'SkillId', + 'in' => 'query', + 'schema' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '17', 'title' => ''], + ], + [ + 'name' => 'SkillLevel', + 'in' => 'query', + 'schema' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'Deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9927CD06-C33A-50CC-A9BB-A3427967A66F', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**: The request was successful.'."\n" - .'* **false**: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'Qno' => ['description' => 'The queue number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2026-03-30 06:12:34', 'title' => ''], + 'QueueId' => ['description' => 'The queue ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '51937', 'title' => ''], + 'SkillId' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '48735', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the skill-queue association.', 'type' => 'integer', 'format' => 'int64', 'example' => '54475', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600', 'title' => ''], + ], + 'description' => 'The response data object.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', - 'title' => 'CancelRobotTask', - 'summary' => 'Terminates a robocall task.', - 'description' => 'Only a task in progress can be terminated by calling the CancelRobotTask operation, and the task cannot be resumed after it is terminated.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateQueueSkill', + 'summary' => 'Adds a skill to a queue.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9927CD06-C33A-50CC-A9BB-A3427967A66F\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Qno\\": 1000,\\n \\"SkillLevel\\": 10,\\n \\"CreateTime\\": \\"2026-03-30 06:12:34\\",\\n \\"QueueId\\": 51937,\\n \\"SkillId\\": 48735,\\n \\"Id\\": 54475,\\n \\"EnterpriseId\\": 7122600\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateSkill' => [ + 'summary' => 'Creates a skill.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**: The request was successful.'."\n" - .'* **false**: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - ], - ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the skill.', 'type' => 'string', 'required' => true, 'example' => 'skillName', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\t4001112222\\n","errorExample":""}]', - 'title' => 'DeleteRobotTask', - 'summary' => 'Deletes a robocall task.', - 'description' => 'You can call this operation to delete only tasks that are not started, that are completed, and that are terminated.'."\n" - ."\n" - .'### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotv2AllList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The description of the skill.', 'type' => 'string', 'required' => false, 'example' => 'Comment3', 'title' => ''], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The information about the robot communication script, in the JSON format.'."\n" - ."\n" - .'* **id**: the ID of the robot communication script.'."\n" - .'* **robotName**: the name of the robot communication script.'."\n" - .'* **robotType**: the type of the robot communication script.'."\n", - 'type' => 'string', - 'example' => '{"id":100000007****,"robotName":"Robot","robotType":"CUSTOM"}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'Comment' => ['description' => 'The description of the skill.', 'type' => 'string', 'example' => 'Comment3', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time, accurate to the second.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'Id' => ['description' => 'The ID of the skill.', 'type' => 'integer', 'format' => 'int64', 'example' => '49', 'title' => ''], + 'EnterpriseId' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The name of the skill.', 'type' => 'string', 'example' => 'skillName', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":100000007****,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\"}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\t{\\"id\\":100000007****,\\"robotName\\":\\"机器人\\",\\"robotType\\":\\"CUSTOM\\"}\\n","errorExample":""}]', - 'title' => 'QueryRobotv2AllList', - 'summary' => 'Queries a list of robot communication scripts.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotTaskList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateSkill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Comment\\": \\"Comment3\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": 49,\\n \\"EnterpriseId\\": 7000002,\\n \\"Name\\": \\"skillName\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateTask' => [ + 'summary' => 'Creates an outbound call task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test Template', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '36', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The task state. Valid values:'."\n" - ."\n" - .'* **INIT**: The task is not started.'."\n" - .'* **READY**: The task is ready to start.'."\n" - .'* **DISPATCH**: The task is being parsed.'."\n" - .'* **EXCUTING**: The task is being executed.'."\n" - .'* **MANUAL_STOP**: The task is manually suspended.'."\n" - .'* **SYSTEM_STOP**: The task is suspended by the system.'."\n" - .'* **ARREARS_STOP**: The task is suspended due to overdue payments.'."\n" - .'* **CANCEL**: The task is manually canceled.'."\n" - .'* **SYSTEM_CANCEL**: The task is canceled by the system.'."\n" - .'* **FINISH**: The task is complete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'EXCUTING', - ], + 'schema' => ['description' => 'The task name. The value must be URL-encoded in UTF-8 format and be up to 50 characters long.', 'type' => 'string', 'required' => true, 'example' => 'taskName', 'title' => ''], ], [ - 'name' => 'Time', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The date when the task is created, in the yyyy-MM-dd format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-06-14', - ], + 'schema' => ['description' => 'The task description. The value must be URL-encoded in UTF-8 format and be up to 200 characters long.', 'type' => 'string', 'required' => false, 'example' => 'Task Description', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The type of the outbound task. The task type cannot be changed after creation.'."\n" + ."\n" + .'- `1`: Predictive outbound task.'."\n" + ."\n" + .'- `2`: Automated outbound task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'TemplateName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the task template.'."\n" + ."\n" + .'1. You can use a template to centrally manage task parameters and simplify interface calls. Multiple tasks can share the same template. In your interface call, you only need to provide parameters that differ from the template.'."\n" + ."\n" + .'2. Parameter precedence: Parameters provided in the interface call take precedence.'."\n" + ."\n" + .'3. Example: If you specify `autoStart=1` and `templateName=testTemplate` in an interface call, the `autoStart` value from the call is used. If you do not specify the `autoStart` parameter or provide an empty value for it, the value from the template is used.'."\n" + ."\n" + .'> - Use the task template interface to manage task templates.', 'type' => 'string', 'required' => false, 'example' => 'TemplateName', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The robocall tasks, in the JSON format.'."\n" - ."\n" - .'* **id**: the unique ID of the robocall task.'."\n" - .'* **taskName**: the task name.'."\n" - .'* **robotId**: the robot ID.'."\n" - .'* **robotName**: the robot name.'."\n" - .'* **status**: the task state.'."\n" - .'* **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.'."\n" - .'* **createTime**: the time when the task was created, in the yyyy.MM.dd HH:mm:ss format.'."\n" - .'* **completeTime**: the time when the task was completed, in the yyyy.MM.dd HH:mm:ss format.'."\n" - .'* **fireTime**: the time when the task was started, in the yyyy.MM.dd HH:mm:ss format.'."\n" - .'* **totalCount**: the total number of calls processed.'."\n" - .'* **finishCount**: the number of calls completed.'."\n", - 'type' => 'string', - '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} ]', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'PageNo' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of tasks.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], + [ + 'name' => 'AutoStart', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to schedule the task to start automatically.'."\n" + ."\n" + .'- `0`: Disabled. (Default)'."\n" + ."\n" + .'- `1`: Enabled.'."\n" + ."\n" + .'> * If you set this parameter to `1`, the `autoStartDay` and `autoStartTime` parameters take effect. At least one of them is required.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[ {\\\\\\"id\\\\\\": 1045001, \\\\\\"taskName\\\\\\": \\\\\\"智能语音任务\\\\\\", \\\\\\"robotId\\\\\\": 1000000075003, \\\\\\"robotName\\\\\\": \\\\\\"机器人\\\\\\", \\\\\\"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} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"PageNo\\": \\"1\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n [ {\\"id\\": 1045001, \\"taskName\\": \\"智能语音任务\\", \\"robotId\\": 1000000075003, \\"robotName\\": \\"机器人\\", \\"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} ]\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n 1\\n OK\\n OK\\n 1\\n 1\\n","errorExample":""}]', - 'title' => 'QueryRobotTaskList', - 'summary' => 'Queries the information about all robocall tasks.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryCallDetailByTaskId' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AutoStartDay', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled start date for the task. This parameter takes effect only when `AutoStart` is set to `1`. If you do not specify this parameter, the task starts on the current day at the time specified by `autoStartTime`. Format: `yyyy-MM-dd`. Example: `2017-01-01`.', 'type' => 'string', 'required' => false, 'example' => '2026-01-01', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'AutoStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '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**.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4001112222', - ], + 'schema' => ['description' => 'The scheduled start time for the task. This parameter takes effect only when `AutoStart` is set to `1`. If you do not specify this parameter, the start time defaults to `00:00:00` on the date specified by `autoStartDay`. Format: `HH:mm:ss`. Example: `08:00:00`.', 'type' => 'string', 'required' => false, 'example' => '08:00:00', 'title' => ''], ], [ - 'name' => 'QueryDate', + 'name' => 'AutoStop', 'in' => 'query', - 'schema' => [ - 'description' => '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2020-10-09 09:02:03', - ], + 'schema' => ['description' => 'Specifies whether to schedule the task to stop automatically.'."\n" + ."\n" + .'- `0`: Disabled. (Default)'."\n" + ."\n" + .'- `1`: Enabled.'."\n" + ."\n" + .'> * If you set this parameter to `1`, the `autoStopDay` and `autoStopTime` parameters take effect. At least one of them is required.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Callee', + 'name' => 'AutoStopDay', 'in' => 'query', - 'schema' => [ - 'description' => 'The called number. You can view the outbound call records of only one called number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1390000****', - ], + 'schema' => ['description' => 'The scheduled stop date for the task. This parameter takes effect only when `AutoStop` is set to `1`. If you do not specify this parameter, the task stops on the current day at the time specified by `autoStopTime`. Format: `yyyy-MM-dd`. Example: `2017-01-01`.', 'type' => 'string', 'required' => false, 'example' => '2026-01-01', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => 'The call details of the outbound robocall task, in the JSON format.'."\n" - ."\n" - .'* **startDate**: the time when the call was answered.'."\n" - ."\n" - .'* **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.'."\n" - ."\n" - .'* **statusCode**: the status code.'."\n" - ."\n" - .'* **EndDate**: the time when the call was ended.'."\n" - ."\n" - .'* **calleeShowNumber**: the calling number displayed to the called party.'."\n" - ."\n" - .'* **callee**: the called number.'."\n" - ."\n" - .'* **duration**: the billing duration.'."\n" - ."\n" - .'* **gmtCreate**: the time when the outbound robocall task was created.'."\n" - ."\n" - .'* **hangupDirection**: the party who hung up.'."\n" - ."\n" - .'* **tags**: the call tags.'."\n" - ."\n" - .'* **dialogCount**: the number of conversation rounds in the call.'."\n" - ."\n" - .'* **sureCount**: the number of times that the robocall task was acknowledged.'."\n" - ."\n" - .'* **denyCount**: the number of times that the robocall task was denied.'."\n" - ."\n" - .'* **rejectCount**: the number of times that the robocall task was rejected.'."\n" - ."\n" - .'* **customCount**: the number of times that the robocall task was customized.'."\n" - ."\n" - .'* **knowledgeCount**: the number of times that the knowledge base was queried.'."\n" - ."\n" - .'* **recordFile**: the download URL of the recording file. The URL is valid only for 48 hours. The recording file must be downloaded in time.'."\n" - ."\n" - .'* **callId**: the call ID.'."\n" - ."\n" - .'* **recordStatus**: indicates whether a recording file was available. Valid values:'."\n" - ."\n" - .' * 1: A recording file was available.'."\n" - .' * 2: No recording file was available.'."\n" - ."\n" - .'* **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.'."\n" - ."\n" - .'* **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.'."\n" - ."\n" - .'* **callee**: the called number.'."\n" - ."\n" - .'* **dialogDetail**: the conversation details. The value is a JSON array that contains the following parameters:'."\n" - ."\n" - .' * **role**: the role who spoke.'."\n" - .' * **content**: the content of the speech.'."\n" - .' * **time**: the start time of the speech.'."\n" - ."\n" - .'> The preceding parameters are for reference only. The actually returned parameters prevail.'."\n", - 'type' => 'string', - '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}'."\n", - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D86B61A8-F2EE-4E4C-9F05-08A4676FFD89', - ], - ], - ], + [ + 'name' => 'AutoStopTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled stop time for the task. This parameter takes effect only when `AutoStop` is set to `1`. If you do not specify this parameter, the stop time defaults to `23:59:59` on the date specified by `autoStopDay`. Format: `HH:mm:ss`. Example: `17:00:00`.', 'type' => 'string', 'required' => false, 'example' => '17:00:00', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"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}\\\\n\\",\\n \\"RequestId\\": \\"D86B61A8-F2EE-4E4C-9F05-08A4676FFD89\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\t{"rejectCount":0,"dialogCount":3,"tags":1,"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%2F5fdJUQu****&Expires=1554382725","defaultCount":0,"endDate":"2019-03-27 10:35:09","calleeShowNumber":"053158552960","customCount":0,"callId":"115987800002^102789420002","dialogDetail":[{"content":"我的呼叫测试","startTime":"Wed Mar 27 10:34:45 CST 2019","role":"robot"},{"content":"喂，哎，你好","startTime":"Wed Mar 27 10:35:00 CST 2019","role":"custom"},{"content":"不好意思，可以慢点再说一遍吗?","startTime":"Wed Mar 27 10:35:00 CST 2019","role":"robot"},{"content":"喂","startTime":"Wed Mar 27 10:35:01 CST 2019","role":"custom"},{"content":"哦再见","startTime":"Wed Mar 27 10:35:08 CST 2019","role":"custom"},{"content":"不好意思，我这边听得不是很清楚，您可以再说一遍吗？","startTime":"Wed Mar 27 10:35:08 CST 2019","role":"robot"}],"knowledgeCount":0,"recordStatus":1,"denyCount":0,"duration":16,"knowledgeCommonCount":0,"callee":"13735460951","knowledgeBusinessCount":0,"hangupDirection":1}\\r\\n\\tOK\\r\\n\\tD86B61A8-F2EE-4E4C-9F05-08A4676FFD89\\r\\n\\tOK\\r\\n","errorExample":""}]', - 'title' => 'QueryCallDetailByTaskId', - 'summary' => 'Queries the call details of an outbound robocall task.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotTaskDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ForceEndFlag', + 'in' => 'query', + 'schema' => ['description' => 'Whether to forcibly end the task at its scheduled stop time. This parameter takes effect only when `AutoStop` is set to `1`.'."\n" + .'Valid values:', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'AutoTaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['description' => 'Specifies the call schedule type. This parameter is used with the `autoStart` and `autoStop` parameters. Use interval calling if the task must run only during specific time periods each day. By default, calls are made continuously.'."\n" + ."\n" + .'- `0`: Continuous calling.'."\n" + ."\n" + .'- `1`: Interval calling.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => 'The details of the robocall task, in the JSON format.'."\n" - ."\n" - .'* **Id**: the unique ID of the robocall task.'."\n" - .'* **taskName**: the task name.'."\n" - .'* **robotId**: the robot ID.'."\n" - .'* **robotName**: the robot name.'."\n" - .'* **corpName**: the company name.'."\n" - .'* **caller**: the number displayed to the called party.'."\n" - .'* **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.'."\n" - .'* **status**: the task state. You can call the [QueryRobotTaskList](~~QueryRobotTaskList~~) operation to obtain the task state from the `status` parameter.'."\n" - .'* **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.'."\n" - .'* **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.'."\n" - .'* **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.'."\n" - .'* **recallTimes**: the number of redial times.'."\n" - .'* **recallInterval**: the redial interval. Unit: minutes.'."\n" - .'* **createTime**: the time when the task was created, in the yyyy-MM-dd HH:mm:ss format.'."\n" - .'* **fireTime**: the time when the task was started, in the yyyy-MM-dd HH:mm:ss format.'."\n" - .'* **completeTime**: the time when the task was completed, in the yyyy-MM-dd HH:mm:ss format.'."\n" - .'* **filename**: the name of the called number file.'."\n" - .'* **ossFilePath**: the path of the called number file.'."\n", - 'type' => 'string', - '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"}]}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - ], - ], + [ + 'name' => 'AutoTriggerTimeStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The time periods for interval calling. This parameter is required when `AutoTaskType` is set to `1`. It specifies the time condition IDs for the call periods. Separate multiple IDs with commas (`,`). Example: `9,22`.'."\n" + ."\n" + .'> - Call the interface that queries time condition settings to obtain the list of time conditions.', 'type' => 'string', 'required' => false, 'example' => '9,22', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":1045001,\\\\\\"taskName\\\\\\":\\\\\\"智能语音务\\\\\\",\\\\\\"robotId\\\\\\":1000000075003,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"corpName\\\\\\":\\\\\\"xx公司 \\\\\\",\\\\\\"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\\\\\\"}]}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 0571568xxxx,0571568xxxx\\n 2019-06-14 11:04:19\\n INIT\\n 1\\n 智能语音务\\n 机器人\\n 1045001\\n true\\n SINGLE\\n xx公司 \\n 2\\n 2019-06-14 11:05:23\\n 1000000075003\\n \\n http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx\\n 5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi\\n \\n 5\\n 200010,200011\\n 2019-06-14 18:21:06\\n\\nOK\\nD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\nOK\\n\\n","errorExample":""}]', - 'title' => 'QueryRobotTaskDetail', - 'summary' => 'Queries the details of a robocall task.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotTaskCallList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AutoComplete', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically complete the task.'."\n" + ."\n" + .'- `1`: Enabled. After all numbers in the task are called, the task is automatically completed and its status is set to `Ended`.'."\n" + ."\n" + .'- `0`: Disabled. After all numbers in the task are called, the task is automatically paused and its status is set to `Paused`.'."\n" + ."\n" + .'> * A task in the `Ended` state cannot be restarted.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'RetryStrategy', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The retry strategy.'."\n" + ."\n" + .'1. **Basic Mode**'."\n" + ."\n" + .' - Data structure: A JSON object. Example: `{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}`'."\n" + ."\n" + .' - Format description: `retry` specifies the number of retry attempts. `round` specifies the retry attempt number. `time` specifies the interval for the retry attempt in `D-H-M` format, where `D` is days, `H` is hours, and `M` is minutes.'."\n" + ."\n" + .'2. **Advanced Mode**'."\n" + ."\n" + .' - This mode requires the "Number Status Recognition" service to be enabled.'."\n" + .' Data structure: A JSON array. Example: `[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]`'."\n" + ."\n" + .' - Format description: `condition` specifies the retry condition. `sort` specifies the priority of the retry condition. Other fields are the same as in Basic Mode.'."\n" + ."\n" + .'> - The system automatically identifies the mode based on the provided parameter format. When retrying based on the first call time, the interval for each subsequent round must be longer than the previous one.', 'type' => 'string', 'required' => false, 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RetryStrategyTimeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The time reference for the retry strategy. This parameter takes effect only when a retry strategy is configured.'."\n" + ."\n" + .'- `1`: Based on the first call time. (Default)'."\n" + ."\n" + .'- `2`: Based on the last call time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'RetryStrategyOnlyToday', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the task ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001****', - ], + 'schema' => ['description' => 'Specifies whether the task is valid only for the current day.'."\n" + ."\n" + .'- `0`: Disabled. (Default)'."\n" + ."\n" + .'- `1`: Enabled. Deletes both numbers pending retry and numbers pending calls.'."\n" + ."\n" + .'- `2`: Enabled. Deletes only numbers pending retry.'."\n" + ."\n" + .'- `3`: Enabled. Deletes only numbers pending calls.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'DurationFrom', + 'name' => 'CallPriorityStrategy', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum call duration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '- Example: `{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}`'."\n" + ."\n" + .'- - `sort`: The priority order for calling numbers pending retry versus numbers not yet called.'."\n" + ."\n" + .' - `type`: The category of numbers to prioritize. Valid values: `retryCall` (numbers pending retry) and `firstCall` (numbers not yet called).'."\n" + ."\n" + .' - `desc`: Used when `type` is `retryCall`. Determines the order for retrying calls.'."\n" + ."\n" + .' - `0`: Prioritizes numbers with fewer retry rounds (e.g., Round 1 is called before Round 2).'."\n" + ."\n" + .' - `1`: Prioritizes numbers with more retry rounds (e.g., Round 5 is called before Round 4).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'DurationTo', + 'name' => 'CustomerClidsCategory', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum call duration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The type of caller ID to display to customers.'."\n" + ."\n" + .'- `1`: Landline number.'."\n" + ."\n" + .'- `2`: Mobile number.'."\n" + ."\n" + .'- `4`: Number pool.'."\n" + ."\n" + .'- `5`: Caller ID navigation.'."\n" + ."\n" + .'> * We recommend using caller ID navigation for flexible control over your caller ID strategy. Other types will be deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DialogCountFrom', + 'name' => 'CustomerClids', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum number of conversation rounds in the call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'A list of caller IDs to display. This parameter is required when `CustomerClidsCategory` is `1` or `2`. Separate multiple numbers with commas (`,`). This parameter is not recommended.', 'type' => 'string', 'required' => false, 'example' => '7744331,7744332', 'title' => ''], ], [ - 'name' => 'DialogCountTo', + 'name' => 'CustomerClidType', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of conversation rounds in the call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The rule for selecting a caller ID. This parameter takes effect when `CustomerClidsCategory` is `1` or `2`. This parameter is not recommended.'."\n" + ."\n" + .'- `1`: Random. (Default)'."\n" + ."\n" + .'- `2`: By area code.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'HangupDirection', + 'name' => 'ClidProperty', 'in' => 'query', - 'schema' => [ - 'description' => 'The party who hangs up. Valid values:'."\n" - ."\n" - .'* **0**: the called party.'."\n" - .'* **1**: the robot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The caller ID selection rule details, specified as a JSON object. This parameter takes effect when `CustomerClidType` is `2`. It defines rules such as the default area code and whether to match provincial capitals. Example: `{"defaultAreaCode":"010", "isMatchCapital":"1"}`. This parameter is not recommended.', 'type' => 'string', 'required' => false, 'example' => '{"defaultAreaCode":"010", "isMatchCapital":"1"}', 'title' => ''], ], [ - 'name' => 'CallResult', + 'name' => 'CustomerClidWeightFlag', 'in' => 'query', - 'schema' => [ - 'description' => 'The call result. Valid values:'."\n" - ."\n" - .'* **200002**: The line is busy.'."\n" - .'* **200005**: The called party cannot be connected.'."\n" - .'* **200010**: The phone of the called party is powered off.'."\n" - .'* **200011**: The called party is out of service.'."\n" - .'* **200012**: The call is lost.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200002', - ], + 'schema' => ['description' => 'Whether to enable weighted distribution for caller IDs. This parameter takes effect when `CustomerClidsCategory` is `1`. This parameter is not recommended.'."\n" + ."\n" + .'- `0`: Disabled. (Default)'."\n" + ."\n" + .'- `1`: Enabled.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Called', + 'name' => 'CustomerClidWeight', 'in' => 'query', - 'schema' => [ - 'description' => 'The called number.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1300****0000', - ], + 'schema' => ['description' => 'The weighted distribution configuration for caller IDs, specified as a JSON array. This parameter takes effect when `CustomerClidsCategory` is `1` and `CustomerClidWeightFlag` is `1`. Example: `[{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]`. This parameter is not recommended.', 'type' => 'string', 'required' => false, 'example' => '[{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]', 'title' => ''], + ], + [ + 'name' => 'CustomerClidsGroup', + 'in' => 'query', + 'schema' => ['description' => 'The name of the number pool or the identifier of the caller ID navigation. This parameter is required when `CustomerClidsCategory` is `4` or `5`.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], + ], + [ + 'name' => 'CustomerTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The customer timeout duration, in seconds. Default value: `30`. Value range: `5` to `60`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'CallRouteStrategy', + 'in' => 'query', + 'schema' => ['description' => '- `1`: Direct to agent. After the customer answers, the call is immediately routed to an agent. If no agents are available, the call can overflow to an IVR (if configured) to ensure a direct connection experience for high-priority customers.'."\n" + ."\n" + .'- `2`: AI-to-agent transfer. After the customer is connected, the call is first routed to an AI bot configured in the IVR. The call is transferred to an agent based on the interaction result. This increases automation and reduces labor costs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IvrId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the IVR. Specify either `IvrId` or `IvrName`. `IvrId` takes precedence if both are provided. For automated outbound tasks, one of these two parameters is required.

**Predictive outbound task use case**: If an agent is not available within a specific time (default: 2 seconds) after the customer answers, the call overflows to the IVR to queue for an agent. The system also supports overflowing to the IVR if an agent does not answer a transferred call (requires enterprise-level configuration).

**Automated outbound task use case**: The IVR to which the call is transferred after the customer answers.



', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '42', 'title' => ''], + ], + [ + 'name' => 'IvrName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the IVR. Specify either `IvrId` or `IvrName`. `IvrId` takes precedence if both are provided. For automated outbound tasks, one of these two parameters is required.', 'type' => 'string', 'required' => false, 'example' => 'IvrName1', 'title' => ''], + ], + [ + 'name' => 'Concurrency', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of concurrent calls for the task. If `Type` is `1`, setting this parameter to `0` removes the limit. We recommend configuring this parameter if you have fewer than 10 agents.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'UserFields', + 'in' => 'query', + 'schema' => ['description' => 'Custom task fields, specified as a JSON array. Each element in the array can only contain one key-value pair. If an element contains multiple pairs, only the first pair is used. Example: `[{"name":"1234"},{"name1":"12345"}]`. The default is null.'."\n" + .'> The value of a single field cannot exceed 1,000 characters.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"1234"},{"name1":"12345"}]', 'title' => ''], + ], + [ + 'name' => 'CallVariables', + 'in' => 'query', + 'schema' => ['description' => 'Agent channel variables, specified as a JSON array. You can specify a maximum of five variables. Example: `[{"name":"abcdefg","value":"${cdr_enterprise_id}"}]`. The default is null. The variables are passed to the agent channel as SIP headers.'."\n" + .'> The value of a single field cannot exceed 1,000 characters.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] ', 'title' => ''], + ], + [ + 'name' => 'TimeStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The time condition IDs for periods when calls are prohibited. Separate multiple IDs with commas (`,`). Example: `9,22`.'."\n" + .'> Call the interface that queries time condition settings to obtain the list of time conditions.', 'type' => 'string', 'required' => false, 'example' => '9,22', 'title' => ''], + ], + [ + 'name' => 'AutoDelete', + 'in' => 'query', + 'schema' => ['description' => 'Whether to automatically delete the oldest completed task when the maximum task limit is reached.'."\n" + .'> `autoDelete` is not a task attribute. It takes effect only during this specific interface call.'."\n" + ."\n" + .'- `0`: Disabled.'."\n" + ."\n" + .'- `1`: Enabled. The oldest completed task is automatically deleted.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'CallGroupType', + 'in' => 'query', + 'schema' => ['description' => 'The method for specifying agents.'."\n" + ."\n" + .'- `1`: By agent ID list. (Default)'."\n" + ."\n" + .'- `2`: By agent group.'."\n" + ."\n" + .'> * You cannot change this parameter after the task is created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'The agent IDs. This parameter is required when `CallGroupType` is `1`. Separate multiple agent IDs with commas (`,`).'."\n" + .'> An agent can be part of only one running task at a time.', 'type' => 'string', 'required' => false, 'example' => '1111,2222', 'title' => ''], + ], + [ + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the agent group. This parameter is required when `CallGroupType` is `2`.'."\n" + .'> An agent group can be assigned to multiple tasks, but it can be active in only one running task at a time.', 'type' => 'string', 'required' => false, 'example' => '33', 'title' => ''], + ], + [ + 'name' => 'CallStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The agent allocation strategy.'."\n" + ."\n" + .'- `1`: Random. (Default)'."\n" + ."\n" + .'- `2`: Sequential.'."\n" + ."\n" + .'- `3`: Longest time since last call (time elapsed since the last call ended).'."\n" + ."\n" + .'- `4`: Longest idle duration (time elapsed since the agent last switched to the `Idle` state).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AgentTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The agent timeout duration, in seconds. Default value: `10`. Value range: `5` to `60`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '52', 'title' => ''], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['description' => 'The agent wrap-up time, in seconds. Default value: `30`. Value range: `1` to `10800`. A longer wrap-up time reduces the number of calls in each batch.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'MaxWaitTime', + 'in' => 'query', + 'schema' => ['description' => 'The maximum allowed idle time for an agent, in seconds. Default value: `40`. Value range: `10` to `600`. During task execution, if the average agent idle time exceeds this value, the number of calls per batch increases.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40', 'title' => ''], + ], + [ + 'name' => 'MinAvailableAgentCount', + 'in' => 'query', + 'schema' => ['description' => 'The minimum number of available agents. Default value: `10`. Value range: `1` to `10`. If the number of available agents in the task drops below this value, the task is automatically paused to prevent nuisance calls.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Quotiety', + 'in' => 'query', + 'schema' => ['description' => 'The nuisance control ratio. Default value: `1`. Value range: `(0, 20]`. Supports up to two decimal places. A smaller value results in fewer calls, while a larger value increases the number of calls and improves agent utilization.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '17.62', 'title' => ''], + ], + [ + 'name' => 'PredictAdjust', + 'in' => 'query', + 'schema' => ['description' => 'The over-dial rate. Default value: `100`. Value range: `50` to `400`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55', 'title' => ''], + ], + [ + 'name' => 'CallLimitStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The daily call limit per agent, specified as a JSON array. Example: `[{"cnos":["2000","2001"],"limit":"5"}]`.'."\n" + .'> To use this feature, you must enable it in your enterprise configuration. The system starts tracking the daily call count only after the feature is enabled and a limit is set.', 'type' => 'string', 'required' => false, 'example' => ' [{"cnos":["2000","2001"],"limit":"5"}]', 'title' => ''], + ], + [ + 'name' => 'CustomerMoh', + 'in' => 'query', + 'schema' => ['description' => 'The music on hold for the customer. This audio plays while the customer waits for an agent. The default is silence. You can use public or enterprise audio files. Specify the path of the audio file.', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819', 'title' => ''], + ], + [ + 'name' => 'CustomerVoice', + 'in' => 'query', + 'schema' => ['description' => 'The audio prompt for the customer. This audio plays after the customer answers and before the call is transferred to an agent. The system starts searching for an agent after the prompt finishes playing. By default, no prompt is played. Specify the path of a public or enterprise audio file.', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819', 'title' => ''], + ], + [ + 'name' => 'AnswerRate', + 'in' => 'query', + 'schema' => ['description' => 'The initial estimated answer rate for customers. Default value: `50`. Value range: `1` to `100`. During the warm-up phase, the call frequency is calculated based on this rate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '59', 'title' => ''], + ], + [ + 'name' => 'WarmUpDuration', + 'in' => 'query', + 'schema' => ['description' => 'The task warm-up duration, in seconds. Default value: `300`. Value range: `60` to `600`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '93', 'title' => ''], + ], + [ + 'name' => 'IsRewarm', + 'in' => 'query', + 'schema' => ['description' => 'Whether to re-warm up the task after it is paused.'."\n" + ."\n" + .'- `0`: Disabled.'."\n" + ."\n" + .'- `1`: Enabled. (Default)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'The reason why the access is denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The information about the robocall task, which is a JSON-formatted array.'."\n" - ."\n" - .'* **taskId**: the unique ID of the robocall task.'."\n" - .'* **caller**: the calling number.'."\n" - .'* **called**: the called number.'."\n" - .'* **duration**: the call duration. Unit: seconds.'."\n" - .'* **label**: the label of the called party.'."\n" - .'* **dialogCount**: the number of conversation rounds in the call.'."\n" - .'* **callResult**: the call result.'."\n" - .'* **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.'."\n" - .'* **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.'."\n" - .'* **transferNumber**: the phone number of the agent to whom the call was transferred.'."\n" - .'* **transferFailReason**: the reason why the call failed to be transferred to an agent.'."\n" - .'* **callId**: the unique receipt ID of the call.'."\n" - .'* **recallCurTimes**: the number of recalls.'."\n" - .'* **callStartTime**: the start time of the call.'."\n" - .'* **callEndTime**: the end time of the call.'."\n" - .'* **sureCount**: the number of times that the robocall task was acknowledged.'."\n" - .'* **denyCount**: the number of times that the robocall task was denied.'."\n" - .'* **rejectCount**: the number of times that the robocall task was rejected.'."\n" - .'* **customCount**: the number of times that the robocall task was customized.'."\n" - .'* **knowledgeCount**: the number of times that the knowledge base was queried.'."\n" - .'* **defaultCount**: the default number of calls.'."\n" - .'* **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.'."\n" - .'* **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.'."\n" - .'* ****'."\n", - 'type' => 'string', - '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"} ]', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'OverTime' => ['description' => 'The time when the task ended.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'CustomerTimeout' => ['description' => 'The customer timeout period.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Description' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AutoStopDay' => ['description' => 'The date on which the task is scheduled to stop. The date format is yyyy-MM-dd. Example: 2026-04-11.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AgentTimeout' => ['description' => 'The agent timeout period, in seconds.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Cnos' => ['description' => 'The list of agent IDs.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Concurrency' => ['description' => 'The maximum number of concurrent calls.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'CustomerClids' => ['description' => 'The list of caller IDs that are displayed on the customer side.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AutoComplete' => ['description' => 'Specifies whether to automatically complete the task.'."\n" + ."\n" + .'- `0`: no'."\n" + ."\n" + .'- `1`: yes', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AutoStart' => ['description' => 'Specifies whether to automatically start the task.'."\n" + ."\n" + .'- `0`: no'."\n" + ."\n" + .'- `1`: yes', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AnswerRate' => ['description' => 'The estimated call answer rate.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Status' => ['description' => 'The task status.'."\n" + ."\n" + .'- `0`: Initial'."\n" + ."\n" + .'- `1`: Running'."\n" + ."\n" + .'- `2`: Paused'."\n" + ."\n" + .'- `3`: Finished', 'type' => 'string', 'example' => '3', 'title' => ''], + 'CustomerMoh' => ['description' => 'The music on hold (MOH) for customers.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AutoStartDay' => ['description' => 'The date on which the task is scheduled to start. The date format is yyyy-MM-dd.', 'type' => 'string', 'example' => '2016-04-11', 'title' => ''], + 'UserFields' => ['description' => 'The custom fields of the task. This parameter is a JSON array.', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]', 'title' => ''], + 'PredictAdjust' => ['description' => 'The over-dialing rate.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created. The time is in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'StartTime' => ['description' => 'The time when the task started.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AutoStop' => ['description' => 'Specifies whether to automatically stop the task.'."\n" + ."\n" + .'- `0`: no'."\n" + ."\n" + .'- `1`: yes', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Wrapup' => ['description' => 'The agent wrap-up time, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'MaxWaitTime' => ['description' => 'The maximum agent wait time, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Type' => ['description' => 'The task type.'."\n" + ."\n" + .'- `1`: predictive outbound call task'."\n" + ."\n" + .'- `2`: automatic outbound call task', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AutoStartTime' => ['description' => 'The time when the task is scheduled to start. The time is in the HH:mm:ss format.', 'type' => 'string', 'example' => '08:00:00', 'title' => ''], + 'IsRandom' => ['description' => 'Specifies whether to make calls in a random manner.'."\n" + ."\n" + .'- `0`: no'."\n" + ."\n" + .'- `1`: yes', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AutoStopTime' => ['description' => 'The time when the task is scheduled to stop. The time is in the HH:mm:ss format.', 'type' => 'string', 'example' => '17:00:00 ', 'title' => ''], + 'Id' => ['description' => 'The outbound call task ID.', 'type' => 'string', 'example' => '11', 'title' => ''], + 'IvrId' => ['description' => 'The IVR ID.', 'type' => 'string', 'example' => '330', 'title' => ''], + 'Quotiety' => ['description' => 'The nuisance rate. This value is accurate to two decimal places.', 'type' => 'string', 'example' => '0.33', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- The value OK indicates that the request was successful.'."\n" + ."\n" + .'- For more information about other error codes, see [Error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"[ {\\\\\\"taskId\\\\\\":\\\\\\"1045001\\\\\\", \\\\\\"caller\\\\\\":\\\\\\"0571-889****\\\\\\", \\\\\\"called\\\\\\": \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\":\\\\\\"60\\\\\\", \\\\\\"label\\\\\\":\\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\":\\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\":\\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\":\\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\":\\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\":\\\\\\"0571-8833****\\\\\\", \\\\\\"transferFailReason\\\\\\":\\\\\\"用户挂断\\\\\\", \\\\\\"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\\\\\\"} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n [ { “taskId” : 1045001， “caller” : “0571-889****”, “called” : “130****0000”, “duration” : “60”, “label” : “邀约，有房，无车”, “dialogCount” : “3”, “callResult” : “无法接通”, “hangupDirection” : “1”, “transferResult“ : “3”, “transferNumber” ：0571-8833****, “transferFailReason” ：“用户挂断”, “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, “konwledgeCount” : 0, “defaultCount” : 0, “knowledgeBusinessCount” : 0, “knowledgeCommonCount” : 0 } ]\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n","errorExample":""}]', - 'title' => 'QueryRobotTaskCallList', - 'summary' => 'Queries the information about a robocall task.', - 'description' => '### QPS limits'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudCreateTask', + 'description' => 'This API creates predictive and automatic outbound call tasks, as specified by the `type` field. To help you manage the task limit, this API includes an option to automatically delete the oldest completed task when the limit is reached.'."\n" ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + .'For service stability, API usage is limited to a maximum of 100 tasks and an import limit of 10 million numbers.'."\n" + ."\n" + .'Requests that exceed these limits will fail.'."\n" + ."\n" + .'To manage your tasks, you can use the following parameter or API:'."\n" + ."\n" + .'- `autoDelete`: Set to `1` to automatically delete the oldest completed task when the task limit is reached.'."\n" + ."\n" + .'- Alternatively, use the `DeleteTask` API to periodically delete completed tasks.'."\n" + ."\n" + .'> * Deleting a task also deletes its number list. However, call details and recording files are retained.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OverTime\\": \\"example\\",\\n \\"CustomerTimeout\\": \\"example\\",\\n \\"Description\\": \\"example\\",\\n \\"AutoStopDay\\": \\"example\\",\\n \\"AgentTimeout\\": \\"example\\",\\n \\"EnterpriseId\\": \\"example\\",\\n \\"Name\\": \\"example\\",\\n \\"Cnos\\": \\"example\\",\\n \\"Concurrency\\": \\"example\\",\\n \\"CustomerClids\\": \\"example\\",\\n \\"AutoComplete\\": 1,\\n \\"AutoStart\\": \\"1\\",\\n \\"AnswerRate\\": \\"example\\",\\n \\"Status\\": \\"3\\",\\n \\"CustomerMoh\\": \\"example\\",\\n \\"AutoStartDay\\": \\"2016-04-11\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"PredictAdjust\\": \\"example\\",\\n \\"CreateTime\\": \\"example\\",\\n \\"StartTime\\": \\"example\\",\\n \\"AutoStop\\": \\"1\\",\\n \\"Wrapup\\": \\"10\\",\\n \\"MaxWaitTime\\": \\"10\\",\\n \\"Type\\": \\"1\\",\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"IsRandom\\": \\"0\\",\\n \\"AutoStopTime\\": \\"17:00:00 \\",\\n \\"Id\\": \\"11\\",\\n \\"IvrId\\": \\"330\\",\\n \\"Quotiety\\": \\"0.33\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryRobotInfoList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudDeleteAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'AuditStatus', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The review state. Valid values:'."\n" - ."\n" - .'* **CONFIGURABLE**'."\n" - .'* **AUDITING**'."\n" - .'* **AUDITPASS**'."\n" - .'* **AUDITFAIL**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AUDITING', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the agent. Valid values: a 3- to 10-digit integer.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'Detailed information about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The basic information about the robot, in the JSON format. The basic information contains the following parameters:'."\n" - ."\n" - .'* **id**: the robot ID.'."\n" - .'* **robotName**: the robot name.'."\n" - .'* **robotType**: the robot type.'."\n" - .'* **auditStatus**: the review state.'."\n" - .'* **gmtCreate**: the time when the task was created.'."\n" - .'* **gmtModified**: the time when the task was modified.'."\n" - .'* **partnerId**: the partner ID.'."\n" - .'* **asrId**: the ID of the automatic speech recognition (ASR) model.'."\n" - .'* **asrType**: the ASR type. Valid values: **Public** and **Private**.'."\n" - .'* **remark**: the additional information.'."\n", - 'type' => 'string', - 'example' => '{["id":1000010920004, "gmtModified":"Thu Mar 21 15:38:55 CST 2019", "auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 12:00:51 CST 2019","remark":"tset","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"Collection scenario"},{"id":1000010920003,"gmtModified":"Thu Mar 21 11:51:10 CST 2019","auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 11:44:57 CST 2019","remark":"test","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"Collection scenario"]}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F59AF338-655D-48E8-9471-5EB07692B1CC', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The result code.'."\n" + ."\n" + .'- A value of `OK` indicates that the request was successful.'."\n" + ."\n" + .'- For other status codes, see the [list of error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{[\\\\\\"id\\\\\\":1000010920004, \\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 15:38:55 CST 2019\\\\\\", \\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 12:00:51 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5--ssml标记2-RVR-副本\\\\\\"},{\\\\\\"id\\\\\\":1000010920003,\\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 11:51:10 CST 2019\\\\\\",\\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 11:44:57 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，内部测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5-ssml标记2-RVR\\\\\\"]}\\",\\n \\"RequestId\\": \\"F59AF338-655D-48E8-9471-5EB07692B1CC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t[{\\"id\\":1000010920004,\\"gmtModified\\":\\"Thu Mar 21 15:38:55 CST 2019\\",\\"auditStatus\\":\\"AUDITPASS\\",\\"gmtCreate\\":\\"Thu Mar 21 12:00:51 CST 2019\\",\\"remark\\":\\"测试勿删，测试请通过\\",\\"partnerId\\":100000022670001,\\"asrId\\":\\"a9a1d69081fd4266ad788346bf5e1b6c\\",\\"robotType\\":\\"CUSTOM\\",\\"asrType\\":\\"1\\",\\"robotName\\":\\"催收场景5-ssml标记2-RVR-副本\\"},{\\"id\\":1000010920003,\\"gmtModified\\":\\"Thu Mar 21 11:51:10 CST 2019\\",\\"auditStatus\\":\\"AUDITPASS\\",\\"gmtCreate\\":\\"Thu Mar 21 11:44:57 CST 2019\\",\\"remark\\":\\"测试勿删，测试请通过\\",\\"partnerId\\":100000022670001,\\"asrId\\":\\"a9a1d69081fd4266ad788346bf5e1b6c\\",\\"robotType\\":\\"CUSTOM\\",\\"asrType\\":\\"1\\",\\"robotName\\":\\"催收场景-ssml标记2-RVR\\"}}]\\r\\n\\tOK\\r\\n\\tE8EF9B41-C4DC-44D5-A25B-DA9AC7791998\\r\\n\\tOK\\r\\n","errorExample":""}]', - 'title' => 'QueryRobotInfoList', - 'summary' => 'Queries a list of robots to obtain their details.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotTaskCallDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteAgent', + 'summary' => 'Deletes an agent by its ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'Callee', + 'name' => 'Gno', 'in' => 'query', - 'schema' => [ - 'description' => 'The called number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '130****0000', - ], + 'schema' => ['description' => 'The number of the agent group to delete.', 'type' => 'string', 'required' => false, 'example' => 'WH123', 'title' => ''], ], - [ - 'name' => 'QueryDate', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The timestamp of the time at which the call details you want to query.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-10-21 08:23:21', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9927CD06-C33A-50CC-A9BB-A3427967A66F', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The call details of a robocall task, in the JSON format.'."\n" - ."\n" - .'* **taskId**: the unique ID of the robocall task.'."\n" - .'* **caller**: the calling number.'."\n" - .'* **called**: the called number.'."\n" - .'* **duration**: the call duration. Unit: seconds.'."\n" - .'* **label**: the label of the called party.'."\n" - .'* **dialogCount**: the number of conversation rounds in the call.'."\n" - .'* **callResult**: the call result.'."\n" - .'* **hangupDirection**: the party who hung up. Valid values: **0**: the robot. **1**: the called party.'."\n" - .'* **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 the agent. The value 0 indicates that the call failed to be transferred to the agent. The value 3 indicates that the call was not transferred to the agent.'."\n" - .'* **transferNumber**: the phone number of the agent to whom the call was transferred.'."\n" - .'* **transferFailReason**: the reason why the call failed to be transferred to the agent.'."\n" - .'* **callId**: the unique receipt ID of the call, in the `taskId^bizId` format.'."\n" - .'* **recallCurTimes**: the number of recalls.'."\n" - .'* **callStartTime**: the start time of the call.'."\n" - .'* **callEndTime**: the end time of the call.'."\n" - .'* **sureCount**: the number of times that the robocall task was affirmed.'."\n" - .'* **denyCount**: the number of times that the robocall task was denied.'."\n" - .'* **rejectCount**: the number of times that the robocall task was rejected.'."\n" - .'* **customCount**: the number of times that the robocall task was customized.'."\n" - .'* **knowledgeCount**: the number of times that the knowledge base was queried.'."\n" - .'* **defaultCount**: the default number of calls.'."\n" - .'* **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.'."\n" - .'* **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.'."\n" - .'* **recordStatus**: Indicates whether the call has a recording file. Valid values: **1**: The call has a recording file. **2**: The call does not have a recording file.'."\n" - .'* **recordFile**: the download URL of the recording file.'."\n" - .'* **dialogDetail**: the dialog details, in a JSON-formatted array. **role**: the object of the speech. **content**: the content of the speech. **speakTime**: the time of the speech.'."\n", - 'type' => 'string', - 'example' => '{ "taskId" : 1045001, "caller" : "0571-8899****", "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, "recordStatus":1, "recordFile": "http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******", "dialogDetail": [{"role": "robot","speakTime": "2019-06-19 20:44:17","content":"prologue"}] }', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'A value of `0` indicates success. Any other value indicates failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{ \\\\\\"taskId\\\\\\" : 1045001, \\\\\\"caller\\\\\\" : \\\\\\"0571-8899****\\\\\\", \\\\\\"called\\\\\\" : \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\" : \\\\\\"60\\\\\\", \\\\\\"label\\\\\\" : \\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\": \\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\" : \\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\" : \\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\" : \\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\" ：0571-8833****, \\\\\\"transferFailReason\\\\\\" ：\\\\\\"用户挂断\\\\\\", \\\\\\"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, \\\\\\"recordStatus\\\\\\":1, \\\\\\"recordFile\\\\\\": \\\\\\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******\\\\\\", \\\\\\"dialogDetail\\\\\\": [{\\\\\\"role\\\\\\": \\\\\\"robot\\\\\\",\\\\\\"speakTime\\\\\\": \\\\\\"2019-06-19 20:44:17\\\\\\",\\\\\\"content\\\\\\":\\\\\\"开场白\\\\\\"}] }\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n { \\"taskId\\" : 1045001, \\"caller\\" : \\"0571-8899****\\", \\"called\\" : \\"130****0000\\", \\"duration\\" : \\"60\\", \\"label\\" : \\"邀约，有房，无车\\", \\"dialogCount\\": \\"3\\", \\"callResult\\" : \\"无法接通\\", \\"hangupDirection\\" : \\"1\\", \\"transferResult\\" : \\"3\\", \\"transferNumber\\" ：0571-8833****, \\"transferFailReason\\" ：\\"用户挂断\\", \\"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, \\"konwledgeCount\\" : 0, \\"defaultCount\\" : 0, \\"knowledgeBusinessCount\\" : 0, \\"knowledgeCommonCount\\" : 0, \\"recordStatus\\":1, \\"recordFile\\": \\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******\\", \\"dialogDetail\\": [{\\"role\\": \\"robot\\",\\"speakTime\\": \\"2019-06-19 20:44:17\\",\\"content\\":\\"开场白\\"}] }\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n","errorExample":""}]', - 'title' => 'QueryRobotTaskCallDetail', - 'summary' => 'Queries the call details of a called number.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UploadRobotTaskCalledFile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteAgentGroup', + 'summary' => 'Deletes an agent group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9927CD06-C33A-50CC-A9BB-A3427967A66F\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteAgentTel' => [ + 'summary' => 'Deletes a phone number from an agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the ID of the robocall task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045****', - ], - ], - [ - 'name' => 'CalledNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The called numbers. Separate multiple called numbers with commas (,).'."\n" - ."\n" - .'> After you create a robocall task, you must upload called numbers in batches. You can upload up to 300,000 called numbers for each task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1370****000,1370****111', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'TtsParam', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => 'The values of the variable in the text-to-speech (TTS) template, in the JSON format. The variable values specified by the TtsParam parameter must match the variable names specified by the TtsParamHead parameter.'."\n" - ."\n" - .'* If all the called numbers carry the same variable values, you can set the value of the number field to **all** and upload only one copy of the variable values.'."\n" - .'* If only some of the called numbers carry the same variable values, you can set the value of the number field to **all** for these called numbers and set the value of the number field and variable values for other called numbers based on your business requirements. The system preferentially selects the values that you set for the called numbers.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[{"number":"1370****000","params":["xiaowang","xiaoli","xiaozhou"]}]', - ], + 'schema' => ['description' => 'The agent ID. It must be a 3- to 10-digit number.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], [ - 'name' => 'TtsParamHead', + 'name' => 'Tel', 'in' => 'query', - 'schema' => [ - 'description' => 'The list of variable names carried in the robocall task, in the JSON format. The TtsParamHead parameter must be used together with the TtsParam parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '["name1","name2","name3"]', - ], + 'schema' => ['description' => 'The phone number to delete from the agent. Include the area code for landline numbers. Do not prefix mobile phone numbers with 0. Use a hyphen (-) to separate a landline number from its extension number.', 'type' => 'string', 'required' => true, 'example' => '22223333', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The unique ID of the robocall task.'."\n" - ."\n" - .'You can call the [QueryRobotTaskDetail](~~QueryRobotTaskDetail~~) operation to query the details of the robocall task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '10450****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [Error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10450****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\t10450****\\n","errorExample":""}]', - 'title' => 'UploadRobotTaskCalledFile', - 'summary' => 'Uploads the called numbers of a robocall task.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetHotlineQualificationByOrder' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteAgentTel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteEnterpriseTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '52683', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'OrderId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ticket ID.'."\n" - ."\n" - .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Qualification\\&Communication Script Management** > **Qualification Management**, and then click the **400 Qualifications** tab to view the ticket ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '22456****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the time condition. Specify either Id or Name.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '92', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the time condition. Specify either Id or Name.', 'type' => 'string', 'required' => false, 'example' => 'name3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FA46FC5-24CB-53BE-94F6-30CD8D66751C', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The qualification state. Valid values:'."\n" - ."\n" - .'* **NORMAL**'."\n" - .'* **OTHER**'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'QualificationId' => [ - 'description' => 'The qualification ID.'."\n", - 'type' => 'string', - 'example' => '1478*****', - ], - 'OrderId' => [ - 'description' => 'The ID of the qualification application ticket.'."\n", - 'type' => 'string', - 'example' => '22456****', - ], + 'Result' => ['description' => 'The result of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal server error occurred.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteEnterpriseTime', + 'summary' => 'Deletes a specified time condition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"QualificationId\\": \\"10000008748****\\",\\n \\"OrderId\\": \\"15334****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n 6086693B-2250-17CE-A41F-06259AB6DB1B\\n \\n NORMA\\n 1478*****\\n 22456****\\n \\n","errorExample":""}]', - 'title' => 'GetHotlineQualificationByOrder', - 'summary' => 'Obtains the qualification ID based on the ID of a qualification application ticket.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"8FA46FC5-24CB-53BE-94F6-30CD8D66751C\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ListHotlineTransferRegisterFile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudDeleteExten' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '52690', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'QualificationId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The qualification ID. You can call the [GetHotlineQualificationByOrder](~~393548~~) operation to obtain the qualification ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1000****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'Exten', 'in' => 'query', + 'schema' => ['description' => 'The extension number. The value must be 3 to 11 digits in length.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '0', - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This is a deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The operation result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteExten', + 'summary' => 'Deletes an extension by its extension number.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteQueue' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '1000', - 'exclusiveMaximum' => false, - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'HotlineNumber', + 'name' => 'Qno', 'in' => 'query', - 'schema' => [ - 'description' => 'The China 400 number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => 'The queue ID.', 'type' => 'string', 'required' => true, 'example' => '1112', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', - ], + 'AccessDeniedDetail' => ['description' => 'This is a deprecated parameter. You can ignore it.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Values' => [ - 'description' => 'The registration file.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MngOpMail' => [ - 'description' => 'The email address of the handler.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'MngOpName' => [ - 'description' => 'The name of the handler.'."\n", - 'type' => 'string', - 'example' => 'A***', - ], - 'CorpName' => [ - 'description' => 'The enterprise name.'."\n", - 'type' => 'string', - 'example' => 'A**', - ], - 'Agree' => [ - 'description' => 'The authenticity of the commitment.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'MngOpMobile' => [ - 'description' => 'The mobile phone number of the handler.'."\n", - 'type' => 'string', - 'example' => '150****0000', - ], - 'MngOpIdentityCard' => [ - 'description' => 'The ID card number of the handler.'."\n", - 'type' => 'string', - 'example' => '5****************9', - ], - 'HotlineNumber' => [ - 'description' => 'The China 400 number.'."\n", - 'type' => 'string', - 'example' => '400****', - ], - 'QualificationId' => [ - 'description' => 'The qualification ID.'."\n", - 'type' => 'string', - 'example' => '1234****', - ], - 'ResUniqueCode' => [ - 'description' => 'The unique code of the query operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], + 'Result' => ['description' => 'A value of `0` indicates success. Other values indicate failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteQueue', + 'summary' => 'Deletes a queue.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"Values\\": [\\n {\\n \\"MngOpMail\\": \\"username@example.com\\",\\n \\"MngOpName\\": \\"A***\\",\\n \\"CorpName\\": \\"A**\\",\\n \\"Agree\\": \\"true\\",\\n \\"MngOpMobile\\": \\"150****0000\\",\\n \\"MngOpIdentityCard\\": \\"5****************9\\",\\n \\"HotlineNumber\\": \\"400903****\\",\\n \\"QualificationId\\": \\"10000004933****\\",\\n \\"ResUniqueCode\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListHotlineTransferRegisterFile', - 'summary' => 'Queries the registration information about a China 400 number.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'SubmitHotlineTransferRegister' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudDeleteQueueSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TransferPhoneNumberInfos', + 'name' => 'EnterpriseId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The registration information about the China 400 number.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PhoneNumber' => [ - 'description' => 'The China 400 number that you want to submit for registration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1580000****', - ], - 'PhoneNumberOwnerName' => [ - 'description' => 'The real name or company name of the number owner.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'A***', - ], - 'IdentityCard' => [ - 'description' => 'The ID card number of the number owner.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '500***', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'QualificationId', + 'name' => 'Qno', 'in' => 'query', - 'schema' => [ - 'description' => 'The qualification ID. You can call the [GetHotlineQualificationByOrder](~~393548~~) operation to obtain the qualification ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10000004933****', - ], + 'schema' => ['description' => 'The queue number.', 'type' => 'string', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'OperatorName', + 'name' => 'SkillId', 'in' => 'query', + 'schema' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '76', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the handler.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'A***', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This is a deprecated parameter. You can ignore it.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation. A value of 0 indicates success. Other values indicate failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteQueueSkill', + 'summary' => 'Deletes a skill from a queue.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteSkill' => [ + 'summary' => 'Deletes a skill.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'OperatorMail', - 'in' => 'query', - 'schema' => [ - 'description' => 'The email address of the handler.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'username@example.com', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'OperatorMailVerifyCode', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The verification code that is received by the mailbox of the handler.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'OperatorMobile', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile phone number of the handler.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '158****7230', - ], + 'schema' => ['description' => 'The ID of the skill. The value must be a positive integer. Specify either this parameter or `Name`. If both are provided, `Id` takes precedence.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '54', 'title' => ''], ], [ - 'name' => 'OperatorMobileVerifyCode', + 'name' => 'Name', 'in' => 'query', + 'schema' => ['description' => 'The name of the skill. Specify either this parameter or `Id`. If both are provided, `Id` takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'name3', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The verification code that is received by the mobile phone of the handler.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'A deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE', 'title' => ''], + 'Message' => ['description' => 'The response message. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The operation result. `0` indicates success and `-1` indicates failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The response status code. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteSkill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteTask' => [ + 'summary' => 'This operation deletes a predictive or automatic outbound call task. You can delete a task only if it is in the `Initial` or `Completed` state. Deleting a task also deletes its associated phone numbers.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'OperatorIdentityCard', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID card number of the handler.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5****************9', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'Agreement', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The authenticity of the commitment. Valid values:'."\n" - ."\n" - .'* **true**: The commitment is authentic.'."\n" - .'* **false**: The commitment is not authentic.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'HotlineNumber', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The China 400 number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => 'The ID of the outbound task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The registration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2258****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Mobile.Invalid', - 'errorMessage' => 'The mobile number is invalid.', - ], - [ - 'errorCode' => 'MobileVerifyCode.Invalid', - 'errorMessage' => 'The mobile verification code is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","type":"json"}]', - 'title' => 'SubmitHotlineTransferRegister', - 'summary' => 'Submits a 400 number for registration.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'SetTransferCalleePoolConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudDeleteTaskTel' => [ + 'summary' => 'Deletes phone numbers from a call task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Details', + 'name' => 'EnterpriseId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the phone numbers for transferring the call.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Caller' => [ - 'description' => 'The calling number.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '150****0000', - ], - 'Called' => [ - 'description' => 'The called number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '151****0000', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'PhoneNumber', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The phone number used for transferring the call.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35', 'title' => ''], ], [ - 'name' => 'QualificationId', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The qualification ID. You can call the [GetHotlineQualificationByOrder](~~393548~~) operation to obtain the qualification ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '190***', - ], + 'schema' => ['description' => 'The ID of the batch.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CalledRouteMode', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => 'The call mode. Valid values:'."\n" - ."\n" - .'* **roundRobin**'."\n" - .'* **random**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'roundRobin', - ], + 'schema' => ['description' => 'The name of the batch. If you specify a batch by name, the most recently added batch with that name is deleted.', 'type' => 'string', 'required' => false, 'example' => 'test_1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The number status. Valid values: `0` (Not called) and `1` (Called).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Tels', + 'in' => 'query', + 'schema' => ['description' => 'The phone numbers to delete. Separate multiple numbers with commas (,). You can delete up to 100,000 numbers per request, even while the task is running. To delete encrypted numbers, ensure they are URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '18360957135', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the phone numbers for transferring the call were configured.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E7518CE1-B0FF-4C6F-9252-BF80271B2F99', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudDeleteTaskTel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E7518CE1-B0FF-4C6F-9252-BF80271B2F99\\"\\n}","type":"json"}]', - 'title' => 'SetTransferCalleePoolConfig', - 'summary' => 'Sets the phone numbers for transferring a call.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryCallInPoolTransferConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudGetAgent' => [ + 'summary' => 'Retrieves the details of a specific agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'PhoneNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The China 400 number used to transfer the call.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', - ], + 'AccessDeniedDetail' => ['description' => 'The details about the failed request.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The time when the call transfer task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1623137002000', - ], - 'CalledRouteMode' => [ - 'description' => 'The call mode. Valid values:'."\n" - ."\n" - .'* **roundRobin**'."\n" - .'* **random**'."\n", - 'type' => 'string', - 'example' => 'random', - ], - 'TransferTimeout' => [ - 'description' => 'The timeout period for transferring the call.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'Details' => [ - 'description' => 'The details of the response parameters.'."\n", + 'Agent' => [ + 'description' => 'An array of agent objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Called' => [ - 'description' => 'The number used to transfer the call.'."\n", - 'type' => 'string', - 'example' => '400****', + 'LoginTime' => ['description' => 'The agent\'s last login time.', 'type' => 'string', 'example' => '1774821736', 'title' => ''], + 'ObClid' => ['description' => 'The outbound caller ID.', 'type' => 'string', 'example' => '22223333', 'title' => ''], + 'Cno' => ['description' => 'The agent\'s work ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'PermitObPreviewTime' => ['description' => 'The allowed time range for preview dialing. The start and end times are separated by a comma (,).', 'type' => 'string', 'example' => '08:00,20:00', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The name of the agent.', 'type' => 'string', 'example' => '李四', 'title' => ''], + 'IsObRemember' => ['description' => 'Indicates if outbound caller ID memory is enabled. Valid values: `"1"` (enabled) and `"0"` (disabled).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'WebrtcUrlType' => ['description' => 'The URL type for the WebRTC softphone. Valid values: `"0"` (enterprise default), `"1"` (public domain name), `"2"` (private line domain name), `"3"` (public IP), and `"4"` (private line IP).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObClidProperty' => ['description' => 'Properties of the outbound caller ID rule, provided as a JSON string.', 'type' => 'string', 'example' => '{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}', 'title' => ''], + 'Property' => ['description' => 'Configuration for agent-initiated hang-ups, provided as a JSON string. The `unLink` parameter indicates if an agent is allowed to hang up (`1`: enabled, `0`: disabled), and the `prohibitDuration` parameter specifies the period for which hang-ups are prohibited.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IsOb' => ['description' => 'Indicates if outbound calls are allowed. Valid values: `1` (allowed) and `0` (not allowed). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The agent status. Valid values: `1` (online) and `0` (offline).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AsrCallType' => ['description' => 'The call types for which ASR transcription is enabled. Valid values: `1` (inbound call), `2` (webcall), `4` (preview dialing), `5` (predictive dialing), and `9` (direct outbound call).', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Comment' => ['description' => 'Additional comments or remarks.', 'type' => 'string', 'example' => '备注', 'title' => ''], + 'MrcpProperty' => ['description' => 'Settings for pushing the voice stream via MRCP for an agent\'s AXB outbound calls, provided as a JSON string.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'CallPower' => ['description' => 'The calling permissions. Valid values: `0` (unrestricted), `1` (domestic long-distance), `2` (local), and `3` (internal calls). Default value: `0`.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The agent\'s creation time, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'IbRecord' => ['description' => 'Indicates if inbound calls are recorded. Valid values: `1` (record) and `0` (do not record). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BindTelType' => ['description' => 'The type of the bound phone. Valid values: `1` (landline), `2` (mobile phone), `3` (extension), and `4` (softphone).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Wrapup' => ['description' => 'The wrap-up time, in seconds. Default value: `10`.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'ObRecord' => ['description' => 'Indicates if outbound calls are recorded. Valid values: `1` (record) and `0` (do not record). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'IsAsr' => ['description' => 'Indicates if ASR transcription is enabled. Valid values: `1` (enabled) and `0` (disabled). Default value: `0`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'QueueList' => [ + 'description' => 'The queues to which the agent belongs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a queue to which the agent belongs.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'example' => '', + 'title' => '', ], + 'AgentType' => ['description' => 'The agent type. Valid values: `1` (phone-based agent) and `2` (PC-based agent). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Active' => ['description' => 'Indicates if the agent is active. Valid values: `1` (active) and `0` (inactive). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ObClidType' => ['description' => 'The rule for selecting the outbound caller ID. Valid values: `1` (enterprise default), `2` (random), `3` (by area code), and `4` (dynamic caller ID).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'IsAxbCall' => ['description' => 'Indicates if AXB outbound calls are enabled. Valid values: `"1"` (enabled) and `"0"` (disabled). Default value: `"1"`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UpdateTime' => ['description' => 'The time of the last update, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'BindTel' => ['description' => 'The phone number bound to the agent.', 'type' => 'string', 'example' => '22223333', 'title' => ''], + 'Id' => ['description' => 'The agent\'s unique internal identifier.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Power' => ['description' => 'The role of the agent. Valid values: `1` (supervisor agent) and `0` (standard agent). Default value: `0`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', + 'title' => '', ], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- `OK` indicates that the request was successful.'."\n" + ."\n" + .'- For other values, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Data\\": {\\n \\"GmtCreate\\": 1623137002000,\\n \\"CalledRouteMode\\": \\"random\\",\\n \\"TransferTimeout\\": \\"30\\",\\n \\"Details\\": [\\n {\\n \\"Called\\": \\"400903****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\n7BF47617-7851-48F7-A3A1-2021342A78E2\\n\\n 1623137002000\\n random\\n 30\\n
\\n 400****\\n
\\n\\nOK\\n","errorExample":""}]', - 'title' => 'QueryCallInPoolTransferConfig', - 'summary' => 'Queries the configuration of the phone number used to transfer a call.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryCallInTransferRecord' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetAgent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Agent\\": [\\n {\\n \\"LoginTime\\": \\"1774821736\\",\\n \\"ObClid\\": \\"22223333\\",\\n \\"Cno\\": \\"1111\\",\\n \\"PermitObPreviewTime\\": \\"08:00,20:00\\",\\n \\"EnterpriseId\\": 7000002,\\n \\"Name\\": \\"李四\\",\\n \\"IsObRemember\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"1\\",\\n \\"ObClidProperty\\": \\"{\\\\\\"isMatchCapital\\\\\\":0,\\\\\\"areaCodeRule\\\\\\":1,\\\\\\"isRandom\\\\\\":1}\\",\\n \\"Property\\": \\"0\\",\\n \\"IsOb\\": 1,\\n \\"Status\\": 1,\\n \\"AsrCallType\\": \\"2\\",\\n \\"Comment\\": \\"备注\\",\\n \\"MrcpProperty\\": \\"{}\\",\\n \\"CallPower\\": 0,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"IbRecord\\": 1,\\n \\"BindTelType\\": 1,\\n \\"Wrapup\\": 20,\\n \\"ObRecord\\": 1,\\n \\"IsAsr\\": 1,\\n \\"QueueList\\": [\\n \\"[]\\"\\n ],\\n \\"AgentType\\": 1,\\n \\"Active\\": 1,\\n \\"ObClidType\\": 1,\\n \\"IsAxbCall\\": \\"0\\",\\n \\"UpdateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"BindTel\\": \\"22223333\\",\\n \\"Id\\": 123,\\n \\"Power\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetAgentStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '52697', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'PhoneNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The phone number to which a call is transferred.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CallInCaller', + 'name' => 'Cno', 'in' => 'query', + 'schema' => ['description' => 'The ID of the agent.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The calling number of the inbound call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '150****0000', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'State' => ['description' => 'The agent\'s status, determined by combining the login status and device status. Possible values: `Offline`, `Idle`, `Busy`, `Wrap-up`, `Calling`, `Ringing`, `On Hold`, and `On a Call`.', 'type' => 'string', 'example' => '空闲', 'title' => ''], + 'LoginStatus' => ['description' => 'The agent\'s login status. Valid values: `0`: Offline, `1`: Online, `2`: Busy, and `3`: Wrap-up.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DeviceStatus' => ['description' => 'The agent\'s device status. This parameter is returned only when the agent is not offline. Valid values: `-1`: Error, `0`: Idle, `1`: Locked, `2`: Inviting, `3`: Ringing, and `4`: In-use.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StateAction' => ['description' => 'The action that corresponds to the status. This parameter is returned only when the agent is not offline.', 'type' => 'string', 'example' => 'idle', 'title' => ''], + 'MainUniqueId' => ['description' => 'The unique ID of the agent\'s current call. This parameter is returned when the device status is `1` (Locked), `2` (Inviting), `3` (Ringing), or `4` (In-use).', 'type' => 'string', 'example' => 'medias_1-162046xxxx.12', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- `OK` indicates that the request was successful.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetAgentStatus', + 'summary' => 'Gets the real-time status of an agent.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"State\\": \\"空闲\\",\\n \\"LoginStatus\\": 1,\\n \\"DeviceStatus\\": 1,\\n \\"StateAction\\": \\"idle\\",\\n \\"MainUniqueId\\": \\"medias_1-162046xxxx.12\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetAreaCode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'QueryDate', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time at which call transfer records are queried, in the YYYY-MM-DD hh:mm:ss format.'."\n" - ."\n" - .'> The query result is all the call transfer records of the specified day.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-28 00:00:00', - ], + 'schema' => ['description' => 'Call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'Tel', 'in' => 'query', + 'schema' => ['description' => 'An 11-digit mobile number. Only mobile numbers can be queried.', 'type' => 'string', 'required' => true, 'example' => '17750247753', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '44D40F36-32D9-555E-89A6-26D39C3044D2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'Tel' => ['description' => 'The mobile number.', 'type' => 'string', 'example' => '183xxxx7093', 'title' => ''], + 'City' => ['description' => 'The city where the phone number is located.', 'type' => 'string', 'example' => '唐山', 'title' => ''], + 'Province' => ['description' => 'The province where the phone number is located.', 'type' => 'string', 'example' => '河北', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetAreaCode', + 'summary' => 'Queries the location of a phone number.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"44D40F36-32D9-555E-89A6-26D39C3044D2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AreaCode\\": \\"010\\",\\n \\"Tel\\": \\"183xxxx7093\\",\\n \\"City\\": \\"唐山\\",\\n \\"Province\\": \\"河北\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetAsr' => [ + 'summary' => 'Retrieve the results of an ASR task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'CallType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the call type. Valid values are: 1 (inbound call), 2 (web call), 4 (preview outbound call), 5 (predictive outbound call), 6 (agent-initiated outbound call), and 9 (internal call).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'MainUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the main channel.', 'type' => 'string', 'required' => true, 'example' => 'sip-2-1490862368.123', 'title' => ''], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => 'If this parameter is set to `true`, the operation returns the two-party conversation text, sorted chronologically by `beginTime`.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', + 'RecordFileCount' => ['description' => 'The number of transcription files.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'MonitorType' => ['description' => 'The transcription type. Valid values: `1` (mixed-channel) and `2` (multi-track).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RecordFileText1In' => [ + 'description' => 'The transcription results for the first party.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the transcription task.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'BizDuration' => ['description' => 'The duration of the speech-to-text conversion. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '33340', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '8f2ff56a7cfe458c942595b2f271d715', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => 'SUCCEED', 'title' => ''], + 'Result' => [ + 'description' => 'The transcription results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the utterance, in milliseconds (ms), from the start of the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '31805', 'title' => ''], + 'SilenceDuration' => ['description' => 'The silence duration, in seconds (s).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the utterance, in milliseconds (ms), from the start of the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '30140', 'title' => ''], + 'Text' => ['description' => 'The transcribed text.', 'type' => 'string', 'example' => '您好，很高兴为您服务', 'title' => ''], + 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'SpeechRate' => ['description' => 'The speech rate, in words per minute (wpm).', 'type' => 'integer', 'format' => 'int64', 'example' => '108', 'title' => ''], + 'EmotionValue' => ['description' => 'The emotion value.', 'type' => 'number', 'format' => 'double', 'example' => '6.0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', + 'RecordFileText1Out' => [ + 'description' => 'The transcription results for the second party.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the transcription task.', 'type' => 'string', 'example' => 'SUCCEED', 'title' => ''], + 'BizDuration' => ['description' => 'The duration of the speech-to-text conversion. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '33340', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '145a13227e3249258cd3b5232a56d634', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Result' => [ + 'description' => 'The transcription results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the utterance, in milliseconds (ms), from the start of the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '31515', 'title' => ''], + 'SilenceDuration' => ['description' => 'The silence duration, in seconds (s).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the utterance, in milliseconds (ms), from the start of the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '30550', 'title' => ''], + 'Text' => ['description' => 'The transcribed text.', 'type' => 'string', 'example' => '你好，我想咨询一些问题', 'title' => ''], + 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'SpeechRate' => ['description' => 'The speech rate, in words per minute (wpm).', 'type' => 'integer', 'format' => 'int64', 'example' => '186', 'title' => ''], + 'EmotionValue' => ['description' => 'The emotion value.', 'type' => 'number', 'format' => 'double', 'example' => '6.0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', ], - 'Values' => [ - 'description' => 'The call transfer records.'."\n", + 'EnterpriseId' => ['description' => 'The contact center ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Result' => [ + 'description' => 'The transcription results. This parameter is returned only when `all` is set to `true`.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CallInCalled' => [ - 'description' => 'The called number of the inbound call.'."\n", - 'type' => 'string', - 'example' => '150****0000', - ], - 'TransferCalled' => [ - 'description' => 'The phone number to which the call was transferred.'."\n", - 'type' => 'string', - 'example' => '151****0000', - ], - 'RecordUrl' => [ - 'description' => 'The recording URL.'."\n", - 'type' => 'string', - 'example' => 'http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684****.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73****&Signature=****mUqkPqIQ%3D', - ], - 'TransferCaller' => [ - 'description' => 'The calling number that transferred the call.'."\n", - 'type' => 'string', - 'example' => '151****0000', - ], - 'GmtCreate' => [ - 'description' => 'The time when the call was initiated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2020-10-03 10:21:21', - ], - 'CallInCaller' => [ - 'description' => 'The calling number of the inbound call.'."\n", - 'type' => 'string', - 'example' => '150****0000', - ], + 'Side' => ['description' => 'The party who spoke the transcribed text. Valid values: `in` (the first party) and `out` (the second party).', 'type' => 'string', 'example' => 'out', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the utterance, in milliseconds (ms), from the start of the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '10445', 'title' => ''], + 'SilenceDuration' => ['description' => 'The silence duration, in seconds (s).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the utterance, in milliseconds (ms), from the start of the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '4350', 'title' => ''], + 'Text' => ['description' => 'The transcribed text.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'SpeechRate' => ['description' => 'The speech rate, in words per minute (wpm).', 'type' => 'integer', 'format' => 'int64', 'example' => '255', 'title' => ''], + 'EmotionValue' => ['description' => 'The emotion value.', 'type' => 'number', 'format' => 'double', 'example' => '7.0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', + 'title' => '', ], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code for the request. A value of `OK` indicates that the request was successful. For information about other status codes, see Error codes.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetAsr', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 50,\\n \\"Values\\": [\\n {\\n \\"CallInCalled\\": \\"150****0000\\",\\n \\"TransferCalled\\": \\"151****0000\\",\\n \\"RecordUrl\\": \\"http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684****.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73****&Signature=****mUqkPqIQ%3D\\",\\n \\"TransferCaller\\": \\"151****0000\\",\\n \\"GmtCreate\\": 0,\\n \\"CallInCaller\\": \\"150****0000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\n7BF47617-7851-48F7-A3A1-2021342A78E2\\n\\n 20\\n 50\\n 1\\n \\n 1624865503000\\n 150****0000\\n http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684eea0.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73PsLI&Signature=****mUqkPqIQ%3D\\n 151****0000\\n 151****0000\\n 150****0000\\n \\n\\nOK\\n","errorExample":""}]', - 'title' => 'QueryCallInTransferRecord', - 'summary' => 'Queries call transfer records.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"RecordFileCount\\": \\"1\\",\\n \\"MonitorType\\": \\"1\\",\\n \\"RecordFileText1In\\": {\\n \\"Status\\": \\"example\\",\\n \\"BizDuration\\": 33340,\\n \\"Id\\": \\"8f2ff56a7cfe458c942595b2f271d715\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"StatusCode\\": 0,\\n \\"Result\\": [\\n {\\n \\"EndTime\\": 31805,\\n \\"SilenceDuration\\": 1,\\n \\"BeginTime\\": 30140,\\n \\"Text\\": \\"您好，很高兴为您服务\\",\\n \\"ChannelId\\": 0,\\n \\"SpeechRate\\": 108,\\n \\"EmotionValue\\": 6\\n }\\n ]\\n },\\n \\"RecordFileText1Out\\": {\\n \\"Status\\": \\"SUCCEED\\",\\n \\"BizDuration\\": 33340,\\n \\"Id\\": \\"145a13227e3249258cd3b5232a56d634\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"StatusCode\\": 0,\\n \\"Result\\": [\\n {\\n \\"EndTime\\": 31515,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 30550,\\n \\"Text\\": \\"你好，我想咨询一些问题\\",\\n \\"ChannelId\\": 0,\\n \\"SpeechRate\\": 186,\\n \\"EmotionValue\\": 6\\n }\\n ]\\n },\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Result\\": [\\n {\\n \\"Side\\": \\"out\\",\\n \\"EndTime\\": 10445,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 4350,\\n \\"Text\\": \\"example\\",\\n \\"ChannelId\\": 32,\\n \\"SpeechRate\\": 255,\\n \\"EmotionValue\\": 7\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'SendVerification' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudGetExten' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52709', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'VerifyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mode of sending the SMS verification code. Set the value to **SMS**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SMS', - ], - ], - [ - 'name' => 'BizType', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The business type. Set the value to **CONTACT**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CONTACT', - ], + 'schema' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'Target', + 'name' => 'Exten', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile phone number that receives the SMS verification code.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '150****0000', - ], + 'schema' => ['description' => 'The extension number. The value must be 3 to 11 digits in length.', 'type' => 'string', 'required' => true, 'example' => '9000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => 'This is a deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the verification code was sent successfully.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', + 'type' => 'object', + 'properties' => [ + 'JitterBuffer' => ['description' => 'The jitter buffer configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CallPower' => ['description' => 'The call permission. Valid values: `0` (Unrestricted), `1` (Domestic Long Distance), `2` (Local Call), and `3` (Internal Call). The default value is `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the extension.', 'type' => 'string', 'example' => '2026-03-30 06:09:04', 'title' => ''], + 'IbRecord' => ['description' => 'Specifies whether to enable recording for an inbound call. Valid values: `0` (Do not record) and `1` (Record). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Exten' => ['description' => 'The extension number. The value must be 3 to 11 digits in length.', 'type' => 'string', 'example' => '9000', 'title' => ''], + 'ObRecord' => ['description' => 'Specifies whether to enable recording for an outbound call. Valid values: `0` (Do not record) and `1` (Record). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Allow' => ['description' => 'The supported voice codecs, separated by commas.', 'type' => 'string', 'example' => 'alaw,ulaw', 'title' => ''], + 'BindGatewayId' => ['description' => 'The ID of the bound agent gateway.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'Type' => ['description' => 'The registration type. Valid values include `1` (IAD extension), `2` (WebRTC), and `3` (remote phone).', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'Denoise' => ['description' => 'Specifies whether to enable noise reduction. This parameter is valid only when `Type` is `2` (WebRTC). Valid values: `0` (Off) and `1` (On). The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The ID of the extension.', 'type' => 'integer', 'format' => 'int64', 'example' => '336450', 'title' => ''], + 'IsDirect' => ['description' => 'Specifies whether to allow off-hook dialing. Valid values: `0` (Disallowed) and `1` (Allowed). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Password' => ['description' => 'The password of the extension.', 'type' => 'string', 'example' => 'Aa248236', 'title' => ''], + 'IsOb' => ['description' => 'Specifies whether to allow outbound calls. Valid values: `0` (Disallowed) and `1` (Allowed). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code. `OK` indicates a successful operation.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => 'The body of the response.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Mobile.Invalid', - 'errorMessage' => 'The mobile number is invalid.', - ], - [ - 'errorCode' => 'UnauthorizedOperation', - 'errorMessage' => 'You have not been authorized.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetExten', + 'summary' => 'Queries information about a specified extension.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\n6086693B-2250-17CE-A41F-06259AB6DB1B\\ntrue\\nOK\\n","errorExample":""}]', - 'title' => 'SendVerification', - 'summary' => 'Sends an SMS verification code.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to 100 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"JitterBuffer\\": 0,\\n \\"CallPower\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-03-30 06:09:04\\",\\n \\"IbRecord\\": 1,\\n \\"Exten\\": \\"9000\\",\\n \\"ObRecord\\": 1,\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Allow\\": \\"alaw,ulaw\\",\\n \\"BindGatewayId\\": 22,\\n \\"Type\\": 2,\\n \\"AreaCode\\": \\"010\\",\\n \\"Denoise\\": 0,\\n \\"Id\\": 336450,\\n \\"IsDirect\\": \\"1\\",\\n \\"Password\\": \\"Aa248236\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'SingleCallByVideo' => [ - 'summary' => 'Sends voice file notifications or video file notifications to a single called number.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudGetObCdr' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5866,101 +4329,132 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '216178', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsX55VQQ', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0571****5678', - ], - ], - [ - 'name' => 'CalledNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1590****000', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'VoiceCode', + 'name' => 'UniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', - ], + 'schema' => ['description' => 'The unique identifier for the call. This value matches the `uniqueId` field in the agent\'s outbound call CDR.', 'type' => 'string', 'required' => true, 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], ], - [ - 'name' => 'PlayTimes', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'Volume', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The access denial details.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'The details of outbound call records of the agent.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayNumber' => ['description' => 'The number displayed to the called party. If you use the AXB mode to make an outbound call, the number displayed to the called party is a virtual number.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'CalleeAreaCode' => ['description' => 'The area code of the callee\'s number.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'EndTime' => ['description' => 'The time when the call ended. This value is a UNIX timestamp. Unit: seconds. Example: 1480904471.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'Clid' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'Cno' => ['description' => 'The agent ID. Example: 2000.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'TrunkGroupKey' => ['description' => 'The code of the trunk group.', 'type' => 'string', 'example' => '30019', 'title' => ''], + 'CallType' => ['description' => 'The call type. The value is Transfer.', 'type' => 'string', 'example' => '呼转座席', 'title' => ''], + 'Gno' => ['description' => 'The outbound call group number of the agent.', 'type' => 'string', 'example' => 'WH514097', 'title' => ''], + 'AnswerTime' => ['description' => 'The time when the call was answered. This value is a UNIX timestamp. Unit: seconds. Example: 1480904471.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'StatusCode' => ['description' => 'The call result code.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'JoinQueueTime' => ['description' => 'The time when the call entered the queue. This value is a UNIX timestamp. Unit: seconds. Example: 1480904471.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'EndReason' => ['description' => 'The reason why the call ended. Valid values: 1000: The user hung up. 1001: The peer party hung up. 1002: The call was torn down.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Qno' => ['description' => 'The queue number.', 'type' => 'string', 'example' => '131', 'title' => ''], + 'RecordFile' => [ + 'type' => 'array', + 'items' => ['description' => 'The recording file name.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'example' => '', + 'description' => 'The array of recording file names.', + 'title' => '', + ], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'QueueName' => ['description' => 'The time when the call entered the queue.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'MainCallType' => ['description' => 'The type of the main call record. The value is Outbound call.', 'type' => 'string', 'example' => '主叫外呼', 'title' => ''], + 'Status' => ['description' => 'The outbound call result. For example, Answered.', 'type' => 'string', 'example' => '接听', 'title' => ''], + 'UniqueId' => ['description' => 'The unique ID of the sub-channel.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'SipCause' => ['description' => 'The SIP response code. The value is an integer from 200 to 699.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'XNumber' => ['description' => 'The virtual number.', 'type' => 'string', 'example' => '示例值', 'title' => ''], + 'CallTypeCode' => ['description' => 'The call type code. Example: 102.', 'type' => 'string', 'example' => '102'."\n", 'title' => ''], + 'RingingTime' => ['description' => 'The time when the call started to ring. This value is a UNIX timestamp. Unit: seconds. Example: 1480904471.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'CallId' => ['description' => 'The unique ID of the call.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'StartTime' => ['description' => 'The time when the call was made to the customer. This value is a UNIX timestamp. Unit: seconds. Example: 1480904471.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'SipCauseStr' => ['description' => 'The call result.', 'type' => 'string', 'example' => '处理成功', 'title' => ''], + 'CalleeNumber' => ['description' => 'The called number, which can be an agent ID or a common phone number.', 'type' => 'string', 'example' => '01041003090', 'title' => ''], + 'MainUniqueId' => ['description' => 'The unique ID of the main outbound call record.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'TotalDuration' => ['description' => 'The total call duration. Unit: seconds.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => '示例值', 'title' => ''], + 'TsiFile' => ['description' => 'The name of the recording file for number status identification.', 'type' => 'string', 'example' => 'name5', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the call record.', 'type' => 'string', 'example' => '797880898', 'title' => ''], + ], + 'description' => 'The details of an outbound call record of the agent.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code of the request.'."\n" + ."\n" + .'- The value OK indicates that the request was successful.'."\n" + ."\n" + .'- For more information about other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetObCdr', + 'summary' => 'Retrieves the details of a specific agent\'s outbound call record by its unique call identifier.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"DisplayNumber\\": \\"02138276106\\",\\n \\"CalleeAreaCode\\": \\"010\\",\\n \\"EndTime\\": \\"1775024775\\",\\n \\"Clid\\": \\"02138276106\\",\\n \\"Cno\\": \\"1111\\",\\n \\"TrunkGroupKey\\": \\"30019\\",\\n \\"CallType\\": \\"呼转座席\\",\\n \\"Gno\\": \\"WH514097\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"StatusCode\\": \\"2\\",\\n \\"JoinQueueTime\\": \\"1775024775\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"131\\",\\n \\"RecordFile\\": [\\n \\"[]\\"\\n ],\\n \\"AgentName\\": \\"name1\\",\\n \\"QueueName\\": \\"1775024775\\",\\n \\"MainCallType\\": \\"主叫外呼\\",\\n \\"Status\\": \\"接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"SipCause\\": \\"200\\",\\n \\"XNumber\\": \\"示例值\\",\\n \\"CallTypeCode\\": \\"102\\\\n\\",\\n \\"RingingTime\\": \\"1775024775\\",\\n \\"CallId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"StartTime\\": \\"1775024775\\",\\n \\"SipCauseStr\\": \\"处理成功\\",\\n \\"CalleeNumber\\": \\"01041003090\\",\\n \\"MainUniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"TotalDuration\\": \\"50\\",\\n \\"TaskName\\": \\"示例值\\",\\n \\"TsiFile\\": \\"name5\\",\\n \\"Id\\": \\"797880898\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetQueue' => [ + 'summary' => 'Retrieves queue information.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Speed', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'OutId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abcdefgh', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'VideoCode', + 'name' => 'Qno', 'in' => 'query', - 'schema' => [ - 'title' => '视频文件', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The queue number.', 'type' => 'string', 'required' => true, 'example' => '355', 'title' => ''], ], ], 'responses' => [ @@ -5968,107 +4462,134 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', - ], - 'CallId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '116012354148^10281378****', + 'AccessDeniedDetail' => ['description' => 'This is a deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'QueueSkills' => [ + 'description' => 'The skills required for the queue.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the skill mapping. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2026-03-30 06:12:33', 'title' => ''], + 'QueueId' => ['description' => 'The queue ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '51937', 'title' => ''], + 'SkillId' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '48734', 'title' => ''], + 'Id' => ['description' => 'The ID of the queue-skill mapping.', 'type' => 'integer', 'format' => 'int64', 'example' => '51937', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'Queue' => [ + 'description' => 'The queue configuration.', + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['description' => 'The threshold, in seconds, for the service level. Calls answered within this time meet the service level.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'AnnounceSound' => ['description' => 'Specifies whether to play a fixed voice prompt. Valid values: `0` (Disabled) and `1` (Enabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'WrapupTime' => ['description' => 'The wrap-up time, in seconds. Valid values: 3 to 3600.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'MaxLen' => ['description' => 'The maximum number of callers that can wait in the queue. Valid values: 0 to 999. A value of `0` indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'queueName', 'title' => ''], + 'AnnouncePosition' => ['description' => 'Specifies when to announce the caller\'s position in the queue. Valid values: `0` (Disabled), `1` (Announce when the position is greater than the `AnnouncePositionParam` value), and `2` (Announce when the position is less than or equal to the `AnnouncePositionParam` value).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnounceSoundFile' => ['description' => 'The fixed voice prompt file.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the queue. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2026-03-30 06:12:33', 'title' => ''], + 'QueueTimeout' => ['description' => 'The timeout period for a call in the queue, in seconds. Valid values: 5 to 600. Default value: 600.', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''], + 'AnnounceSoundFrequency' => ['description' => 'The interval, in seconds, for playing the fixed voice prompt.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionYouarenext' => ['description' => 'Specifies whether to play the "You are next in line" voice prompt. Valid values: `0` (Disabled) and `1` (Enabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionParam' => ['description' => 'The position threshold for the announcement, used with the `AnnouncePosition` parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'MemberTimeout' => ['description' => 'The timeout period for an agent to answer a call, in seconds. Valid values: 20 to 60. Default value: 25.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'Weight' => ['description' => 'The priority of the queue. Valid values: 1 to 10. A higher value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'JoinEmpty' => ['description' => 'Specifies whether a caller can join a queue when no agents are available. This parameter is a bitmask of agent states. Callers are allowed to join if all agents are in states defined by this bitmask. Valid values: `1` (Busy), `2` (In a call), `4` (Ringing), `8` (Invalid), and `16` (Wrap-up).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + 'Qno' => ['description' => 'The queue number.', 'type' => 'string', 'example' => '2632', 'title' => ''], + 'MusicClass' => ['description' => 'The music-on-hold class.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Strategy' => ['description' => 'The call strategy. Valid values: `rrordered` (skill priority), `rrmemory` (round-robin with memory), `fewestcalls` (fewest calls), `random` (random), `linear` (sequential order), and `leastrecent` (longest idle time).', 'type' => 'string', 'example' => 'rrordered', 'title' => ''], + 'Id' => ['description' => 'The queue ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '54473', 'title' => ''], + 'Retry' => ['description' => 'The delay, in seconds, before the system routes the call to the next agent if the current one does not answer.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'SayAgentno' => ['description' => 'Specifies whether to announce the agent\'s number. Valid values: `true` (Enabled) and `false` (Disabled).', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VipSupport' => ['description' => 'Specifies whether VIP support is enabled for the queue. Valid values: `1` (Enabled) and `0` (Disabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionFrequency' => ['description' => 'The interval, in seconds, for announcing the caller\'s position in the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetQueue', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', - 'title' => 'SingleCallByVideo', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"QueueSkills\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"CreateTime\\": \\"2026-03-30 06:12:33\\",\\n \\"QueueId\\": 51937,\\n \\"SkillId\\": 48734,\\n \\"Id\\": 51937,\\n \\"EnterpriseId\\": 7000002\\n }\\n ],\\n \\"Queue\\": {\\n \\"ServiceLevel\\": 10,\\n \\"AnnounceSound\\": 0,\\n \\"WrapupTime\\": 30,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queueName\\",\\n \\"AnnouncePosition\\": 0,\\n \\"AnnounceSoundFile\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2026-03-30 06:12:33\\",\\n \\"QueueTimeout\\": 600,\\n \\"AnnounceSoundFrequency\\": 0,\\n \\"AnnouncePositionYouarenext\\": 0,\\n \\"AnnouncePositionParam\\": 0,\\n \\"MemberTimeout\\": 60,\\n \\"Weight\\": 10,\\n \\"JoinEmpty\\": 1,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"2632\\",\\n \\"MusicClass\\": \\"default\\",\\n \\"Strategy\\": \\"rrordered\\",\\n \\"Id\\": 54473,\\n \\"Retry\\": 5,\\n \\"SayAgentno\\": false,\\n \\"VipSupport\\": 0,\\n \\"AnnouncePositionFrequency\\": 0\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'PlayVideoFile' => [ - 'summary' => 'Plays back a video file during a voice call.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudGetRecordUrl' => [ + 'summary' => 'Call this operation to obtain a preview or download URL for a recording file based on its name.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '201522', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'VideoId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'RecordType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], + 'schema' => ['description' => 'The recording type. If you do not specify this parameter, the system automatically determines the type from the `RecordFile` name. Valid values: `record` (a standard recording), `voicemail` (a voicemail), `tsi` (a color ringback tone used for a preview outbound call to a mobile number that goes unanswered when recording status detection is enabled), `rasr` (a customer-side recording for a voice bot), `transfer` (a transfer), `consult` (a consult), and `threeway` (a three-way call).', 'type' => 'string', 'required' => false, 'example' => 'record', 'title' => ''], ], [ - 'name' => 'CallId', + 'name' => 'RecordFile', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '116012354148^1028137841****', - ], + 'schema' => ['description' => 'The recording file name. Example: `7000101-20160815140025-01087120766-01087120766--record-sip-1-1471240825.87`', 'type' => 'string', 'required' => true, 'example' => '7000101-20160815140025-01087120766-01087120766--record-sip-1-1471240825.87', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'RecordFormat', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '342268*****', - ], + 'schema' => ['description' => 'The recording file type. Valid values: `0` for MP3 (default) and `1` for WAV.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'OnlyPhone', + 'name' => 'CallType', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The call type. This parameter is required to retrieve `customer-side` or `agent-side` recordings when `separate-channel recording` is enabled. It is effective only when `RecordFormat` is set to `1` (WAV) and is ignored if `RecordFormat` is set to `0` (MP3). Valid values: `1` (inbound call), `2` (Webcall), `4` (preview outbound call), and `5` (predictive outbound call).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'RecordSide', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the recording side for a `separate-channel recording`. This parameter is required to retrieve `customer-side` or `agent-side` recordings when `separate-channel recording` is enabled. It is effective only when `RecordFormat` is set to `1` (WAV) and is ignored if `RecordFormat` is set to `0` (MP3). If you specify this parameter, `CallType` is also required. Valid values: `1` (customer side) and `2` (agent side).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Download', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to generate a download link. Set this to `1` for a download URL. If you set this to `0` or leave it empty, a preview URL is generated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -6076,80 +4597,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', + 'AccessDeniedDetail' => ['description' => 'Deprecated parameter.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The pre-signed URL for previewing or downloading the recording. The URL is valid for 120 minutes by default, but this duration is configurable. After the URL expires, you must call this operation again to generate a new one.', 'type' => 'string', 'example' => 'http://voice-1.aliyun.cn/31102016/record/7000000/7000000-2016103111%204742-01087120766-01087120766--record-sip-1-1477885662.222.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161114T100003Z&X-Amz-SignedHeaders=host&X-Amz-Expires=119&X-Amz-Credential=AKIAOTCJOBZFUWFI7FSA%2F20161114%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=0cda4389ecc743acc71d76a320705afd0c175c5ad2286305675c4dee5189b9c8', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'type' => 'boolean', - 'example' => 'false', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'PlayVideoFile', - ], - 'PauseVideoFile' => [ - 'summary' => 'Pauses video playback when a video file is played back during a voice call.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetRecordUrl', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://voice-1.aliyun.cn/31102016/record/7000000/7000000-2016103111%204742-01087120766-01087120766--record-sip-1-1477885662.222.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161114T100003Z&X-Amz-SignedHeaders=host&X-Amz-Expires=119&X-Amz-Credential=AKIAOTCJOBZFUWFI7FSA%2F20161114%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=0cda4389ecc743acc71d76a320705afd0c175c5ad2286305675c4dee5189b9c8\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetTask' => [ + 'summary' => 'Retrieves the configuration for a specific task by its ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '201533', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The ID of the outbound task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '31', 'title' => ''], ], ], 'responses' => [ @@ -6157,160 +4656,291 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], + 'AccessDeniedDetail' => ['description' => 'Deprecated.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'type' => 'object', + 'properties' => [ + 'TaskProperty' => [ + 'description' => 'The task configuration.', + 'type' => 'object', + 'properties' => [ + 'CallVariables' => ['description' => 'The channel variables for the agent, in JSON array format.', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]', 'title' => ''], + 'OverTime' => ['description' => 'The task\'s end time.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AdjustStep' => ['description' => 'The adjustment step.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'CustomerClidType' => ['description' => 'The rule for displaying the caller ID to the customer. Valid values: `1` (Random) and `2` (By area code).', 'type' => 'string', 'example' => '2', 'title' => ''], + 'CustomerVoice' => ['description' => 'The prompt tone played to the customer.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'Cnos' => ['description' => 'A comma-separated list of agent IDs.', 'type' => 'string', 'example' => '111,222', 'title' => ''], + 'CurlRetryTimes' => ['description' => 'Deprecated. The number of retries for push notifications. The maximum value is 5.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'CallbackUrl' => ['description' => 'Deprecated. The callback URL for pushing task status updates to the enterprise.', 'type' => 'string', 'example' => 'deprecated', 'title' => ''], + 'Concurrency' => ['description' => 'The maximum concurrency.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'StatusDescription' => ['description' => 'The task status description.', 'type' => 'string', 'example' => '可用座席数小于1', 'title' => ''], + 'CustomerClids' => ['description' => 'The list of caller IDs (CLIDs) displayed to the customer.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'AutoComplete' => ['description' => 'Specifies whether to enable auto-completion. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AutoStart' => ['description' => 'Specifies whether the task starts automatically at a scheduled time. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CustomerClidWeightFlag' => ['description' => 'Specifies whether to enable proportional caller ID (CLID) weighting. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Status' => ['description' => 'The status of the task. Valid values: `0` (Initialized), `1` (Running), `2` (Paused), and `3` (Finished).', 'type' => 'string', 'example' => '3', 'title' => ''], + 'PauseTime' => ['description' => 'The time when the task was paused.', 'type' => 'string', 'example' => '2026-04-14 16:51:11', 'title' => ''], + 'AutoStartDay' => ['description' => 'The task\'s scheduled start date. The format is `yyyy-MM-dd`. Example: `2017-02-11`.', 'type' => 'string', 'example' => '2026-02-11', 'title' => ''], + 'ClidProperty' => ['description' => 'The caller ID (CLID) rules, in JSON format. The rules include settings for the default area code and whether to match the provincial capital. Example: `{"defaultAreaCode":"010", "isMatchCapital":"1"}`.', 'type' => 'string', 'example' => '{"defaultAreaCode":"010", "isMatchCapital":"1"}', 'title' => ''], + 'RetryStrategyOnlyToday' => ['description' => 'Specifies the end-of-day cleanup policy for pending numbers. Valid values: `0` (Keep all numbers), `1` (Delete initial-call and retry numbers), `2` (Delete retry numbers only), `3` (Delete initial-call numbers only).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'WarmUpDuration' => ['description' => 'The task\'s warm-up duration, in seconds.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'PredictAdjust' => ['description' => 'The over-dial rate.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'StartTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2025-05-10 14:11:15', 'title' => ''], + 'AutoTaskType' => ['description' => 'The call mode. Valid values: `0` (continuous calling) and `1` (interval calling).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'StandbyCnos' => ['description' => 'Deprecated.', 'type' => 'string', 'example' => 'deprecated', 'title' => ''], + 'AutoStartTime' => ['description' => 'The task\'s scheduled start time. The format is `HH:mm:ss`. Example: `08:00:00`.', 'type' => 'string', 'example' => '08:00:00', 'title' => ''], + 'IsRandom' => ['description' => 'Specifies whether to enable random calling. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ForceEndFlag' => ['description' => 'Specifies whether to forcibly end the task at its scheduled completion time. If enabled, the task is marked as `Finished` at the scheduled time, even if not all numbers have been called. This is useful for scenarios with strict call time windows. Note: A task in the `Finished` state cannot be restarted.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The outbound call task ID.', 'type' => 'string', 'example' => '11059', 'title' => ''], + 'Quotiety' => ['description' => 'The nuisance call rate. Supports decimals with up to two decimal places.', 'type' => 'string', 'example' => '3.0', 'title' => ''], + 'AutoTriggerTimeStrategy' => ['description' => 'The time windows for interval calling. The value is a comma-separated list of time condition IDs. Example: `9,22`.', 'type' => 'string', 'example' => '9,22', 'title' => ''], + 'RetryStrategy' => ['description' => 'The retry strategy. In Basic Mode, the value is a JSON object with a structure like `{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}`. In this structure, `retry` is the number of retries, `round` is the retry attempt number, and `time` is the retry interval in D-H-M (Day-Hour-Minute) format. In Advanced Mode, which is available only for automated outbound call tasks with the Number Status Recognition service enabled, the value is a JSON array with a structure like `[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]`. In this structure, `condition` specifies the retry condition, `sort` specifies the priority of the condition, and the remaining fields are the same as in Basic Mode.', 'type' => 'string', 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}', 'title' => ''], + 'CustomerTimeout' => ['description' => 'The customer timeout, in seconds.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'Description' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AutoStopDay' => ['description' => 'The task\'s scheduled completion date. The format is `yyyy-MM-dd`. Example: `2017-02-11`.', 'type' => 'string', 'example' => '2026-02-11', 'title' => ''], + 'TimeStrategy' => ['description' => 'The time windows during which calls are prohibited (do-not-call times). The value is a comma-separated list of time condition IDs. Example: `9,22`.', 'type' => 'string', 'example' => '9,22', 'title' => ''], + 'CustomerClidWeight' => ['description' => 'The proportional caller ID (CLID) weighting configuration. The value is a JSON array. Example: `[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]`.', 'type' => 'string', 'example' => '[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]', 'title' => ''], + 'MinAvailableAgentCount' => ['description' => 'The minimum number of available agents.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AgentTimeout' => ['description' => 'The agent timeout, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'AnswerRate' => ['description' => 'The initial estimated customer answer rate.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'CustomerMoh' => ['description' => 'The music-on-hold (MoH) played to the customer.', 'type' => 'string', 'example' => 'no', 'title' => ''], + 'UserFields' => ['description' => 'The task\'s custom fields, formatted as a JSON array. Example: `[{"key1":"value1"},{"key2":"value2"}]`.', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]', 'title' => ''], + 'ClidGroup' => ['description' => 'Deprecated. The hotline number group.', 'type' => 'string', 'example' => 'deprecated', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2025-05-10 14:07:22', 'title' => ''], + 'OverCallLimitCnos' => ['description' => 'The agents who have exceeded their call limit.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'PauseDuration' => ['description' => 'The task\'s pause duration in minutes, used for auto-start time windows.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AutoStop' => ['description' => 'Specifies whether the task stops automatically at a scheduled time. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Wrapup' => ['description' => 'The agent wrap-up time, in seconds.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'MaxWaitTime' => ['description' => 'The maximum agent wait time, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'TaskFields' => ['description' => 'Deprecated. Task-level call attributes in JSON format, such as `{"key1":"value1","key2":"value2"}`. These attributes are used only for call control and are not passed as channel variables.', 'type' => 'string', 'example' => 'deprecated', 'title' => ''], + 'Type' => ['description' => 'The task type. Valid values: `1` (predictive outbound call task) and `2` (automated outbound call task).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AgentUtilization' => ['description' => 'Deprecated. The agent utilization rate.', 'type' => 'string', 'example' => 'deprecated', 'title' => ''], + 'IsRewarm' => ['description' => 'Specifies whether to re-warm up the task after it is resumed. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AutoStopTime' => ['description' => 'The task\'s scheduled completion time. The format is `HH:mm:ss`. Example: `17:00:00`.', 'type' => 'string', 'example' => '17:00:00', 'title' => ''], + 'CallLimitStrategy' => ['description' => 'The daily answer limit for each agent, in JSON array format. Example: `[{"cnos":["2000","2001"],"limit":"5"}]`.', 'type' => 'string', 'example' => '[{"cnos":["2000","2001"],"limit":"5"}]', 'title' => ''], + 'CallStrategy' => ['description' => 'The agent allocation rule. Valid values: `1` (Random); `2` (Sequential); `3` (Longest time since last call: selects the agent with the longest time elapsed since their last call ended); `4` (Longest idle duration: selects the agent with the longest continuous idle time).', 'type' => 'string', 'example' => '2', 'title' => ''], + 'IvrId' => ['description' => 'The IVR ID.', 'type' => 'string', 'example' => '33', 'title' => ''], + 'CustomerClidsCategory' => ['description' => 'The type of the customer-facing caller ID (CLID). Valid values: `1` (landline number), `2` (mobile number), `4` (CLID pool), and `5` (IVR).', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. `OK` indicates a successful request. For information about other values, see the Error codes section.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'PauseVideoFile', - ], - 'ResumeVideoFile' => [ - 'summary' => 'Resumes video playback after you pause video playback during a voice call.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudGetTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TaskProperty\\": {\\n \\"CallVariables\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"OverTime\\": \\"example\\",\\n \\"AdjustStep\\": \\"5\\",\\n \\"CustomerClidType\\": \\"2\\",\\n \\"CustomerVoice\\": \\"example\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name1\\",\\n \\"Cnos\\": \\"111,222\\",\\n \\"CurlRetryTimes\\": \\"5\\",\\n \\"CallbackUrl\\": \\"deprecated\\",\\n \\"Concurrency\\": \\"0\\",\\n \\"StatusDescription\\": \\"可用座席数小于1\\",\\n \\"CustomerClids\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AutoComplete\\": \\"0\\",\\n \\"AutoStart\\": \\"0\\",\\n \\"CustomerClidWeightFlag\\": \\"0\\",\\n \\"Status\\": \\"3\\",\\n \\"PauseTime\\": \\"2026-04-14 16:51:11\\",\\n \\"AutoStartDay\\": \\"2026-02-11\\",\\n \\"ClidProperty\\": \\"{\\\\\\"defaultAreaCode\\\\\\":\\\\\\"010\\\\\\", \\\\\\"isMatchCapital\\\\\\":\\\\\\"1\\\\\\"}\\",\\n \\"RetryStrategyOnlyToday\\": \\"0\\",\\n \\"WarmUpDuration\\": \\"300\\",\\n \\"PredictAdjust\\": \\"100\\",\\n \\"StartTime\\": \\"2025-05-10 14:11:15\\",\\n \\"AutoTaskType\\": \\"0\\",\\n \\"StandbyCnos\\": \\"deprecated\\",\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"IsRandom\\": \\"0\\",\\n \\"ForceEndFlag\\": \\"0\\",\\n \\"Id\\": \\"11059\\",\\n \\"Quotiety\\": \\"3.0\\",\\n \\"AutoTriggerTimeStrategy\\": \\"9,22\\",\\n \\"RetryStrategy\\": \\"{\\\\\\"retry\\\\\\":2,\\\\\\"strategy\\\\\\":[{\\\\\\"round\\\\\\":1,\\\\\\"time\\\\\\":\\\\\\"1-1-1\\\\\\"},{\\\\\\"round\\\\\\":2,\\\\\\"time\\\\\\":\\\\\\"2-2-2\\\\\\"}]}\\",\\n \\"CustomerTimeout\\": \\"30\\",\\n \\"Description\\": \\"test\\",\\n \\"AutoStopDay\\": \\"2026-02-11\\",\\n \\"TimeStrategy\\": \\"9,22\\",\\n \\"CustomerClidWeight\\": \\"[{\\\\\\"number\\\\\\":\\\\\\"123,345\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"},{\\\\\\"number\\\\\\":\\\\\\"567,789\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"MinAvailableAgentCount\\": \\"1\\",\\n \\"AgentTimeout\\": \\"10\\",\\n \\"AnswerRate\\": \\"100\\",\\n \\"CustomerMoh\\": \\"no\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"ClidGroup\\": \\"deprecated\\",\\n \\"CreateTime\\": \\"2025-05-10 14:07:22\\",\\n \\"OverCallLimitCnos\\": \\"\\\\\\"\\\\\\"\\",\\n \\"PauseDuration\\": \\"0\\",\\n \\"AutoStop\\": \\"0\\",\\n \\"Wrapup\\": \\"30\\",\\n \\"MaxWaitTime\\": \\"10\\",\\n \\"TaskFields\\": \\"deprecated\\",\\n \\"Type\\": \\"1\\",\\n \\"AgentUtilization\\": \\"deprecated\\",\\n \\"IsRewarm\\": \\"0\\",\\n \\"AutoStopTime\\": \\"17:00:00\\",\\n \\"CallLimitStrategy\\": \\"[{\\\\\\"cnos\\\\\\":[\\\\\\"2000\\\\\\",\\\\\\"2001\\\\\\"],\\\\\\"limit\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"CallStrategy\\": \\"2\\",\\n \\"IvrId\\": \\"33\\",\\n \\"CustomerClidsCategory\\": \\"1\\"\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudImportTaskTel' => [ + 'summary' => 'Import phone numbers for the outbound call task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '201535', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100001616500^1000018****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '17', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the batch.', 'type' => 'string', 'required' => true, 'example' => '批次名称1', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the batch. If you specify this parameter, the numbers are added to the existing batch.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '666', 'title' => ''], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => ['description' => 'The priority of the batch. The default value is 0. A larger value indicates a higher priority. The maximum value is 999999.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'IsRepeat', 'in' => 'query', + 'schema' => ['description' => 'Specifies the deduplication policy. Default value: 1. Valid values:'."\n" + ."\n" + .'- 0: Disables deduplication.'."\n" + ."\n" + .'- 1: Deduplicates numbers within the current task.'."\n" + ."\n" + .'- 2: Deduplicates numbers in the current import.'."\n" + ."\n" + .'- 3: Deduplicates numbers within the current batch.'."\n" + ."\n" + .'> * Deduplication within a task and deduplication within a batch cannot be enabled at the same time. If you switch between these policies, the new policy applies to subsequent imports.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'BridgeVoicePath', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the voice file from the enterprise voice library that plays as an opening statement for both parties when an agent answers a call.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], + ], + [ + 'name' => 'BridgeVoiceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the opening statement audio to play when an agent answers a call. This parameter takes effect only if `BridgeVoicePath` is specified. Default value: 3. Valid values:'."\n" + ."\n" + .'- 1: A file from the public voice library.'."\n" + ."\n" + .'- 2: A static script from the enterprise voice library.'."\n" + ."\n" + .'- 3: A dynamic script from the enterprise voice library (which can include variables such as the agent ID).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'TaskTelList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'A list of numbers to import for the task. The size of the request body cannot exceed 8 MB. In a `CtiLinkTaskTel` object, only the `Tel` field is required. Note: Configure [event notification](../%E5%AD%97%E6%AE%B5%E5%AE%9A%E4%B9%89/%E6%8E%A8%E9%80%81%E5%8F%98%E9%87%8F%E5%92%8C%E5%80%BC/%E9%A2%84%E6%B5%8B%E5%A4%96%E5%91%BC%E5%AF%BC%E5%85%A5%E5%8F%B7%E7%A0%81%E5%A4%B1%E8%B4%A5%E6%8E%A8%E9%80%81%E5%8F%98%E9%87%8F.md) to receive details about failed imports.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClidGroup' => ['description' => 'Your account must support routing by identifier to use this parameter. If you specify this parameter, the `Clid` parameter becomes invalid.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], + 'Clid' => ['description' => 'The caller ID to display for the phone number.', 'type' => 'string', 'required' => false, 'example' => '7766551', 'title' => ''], + 'Priority' => ['description' => 'The priority of the number. The default value is 0. A larger value indicates a higher priority. The maximum value is 999999.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '38', 'title' => ''], + 'Tel' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '7455441', 'title' => ''], + 'Property' => ['description' => 'Custom properties for the number, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + 'BackupTels' => ['description' => 'A comma-separated list of up to eight backup numbers to call if the primary number (specified by `Tel`) is unreachable.', 'type' => 'string', 'required' => false, 'example' => '7455332', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '示例值', + 'example' => '', + 'title' => '', ], ], + [ + 'name' => 'ImportTelAutoStart', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically start the task after the import is complete. Default value: 0. Valid values:'."\n" + ."\n" + .'- 0: Does not automatically start the task.'."\n" + ."\n" + .'- 1: Automatically starts the task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'type' => 'object', + 'properties' => [ + 'SuccessTotal' => ['description' => 'The number of successfully imported items.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the import task.', 'type' => 'string', 'example' => '13322333', 'title' => ''], + 'ImportTotal' => ['description' => 'The total number of items in the import request.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'InvalidTotal' => ['description' => 'The number of invalid items.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'FileId' => ['description' => 'The ID of the imported file.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'description' => 'The object containing the returned data.', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ResumeVideoFile', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudImportTaskTel', + 'description' => 'Import numbers by batch. Each request processes a single batch.'."\n" + ."\n" + .'Limits: A maximum of 100,000 numbers per batch, 1,000,000 numbers per task, and 10,000,000 numbers per enterprise.'."\n" + ."\n" + .'The maximum number of batches is 100,000. Any request that exceeds these limits will fail.'."\n" + ."\n" + .'The `Delete numbers in a task` API lets your business platform periodically and automatically delete completed batches or numbers from a task. Even after these numbers are deleted, the platform retains the call detail records and recording files for any calls made using them.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SuccessTotal\\": \\"30\\",\\n \\"TaskId\\": \\"13322333\\",\\n \\"ImportTotal\\": \\"30\\",\\n \\"InvalidTotal\\": \\"0\\",\\n \\"FileId\\": \\"0\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryVideoPlayProgress' => [ - 'summary' => 'Queries the video playback progress after you play a video file during a voice call.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudInterruptIvr' => [ + 'summary' => 'Interrupts a call in a waiting node of a voice navigation flow and directs it to the next hop.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '217974', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '116004767703^102806****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'UniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '159****0000', - ], + 'schema' => ['description' => 'The unique call identifier, which also serves as the unique channel identifier.', 'type' => 'string', 'required' => true, 'example' => '123456789', 'title' => ''], + ], + [ + 'name' => 'UserField', + 'in' => 'query', + 'schema' => ['description' => 'A custom field, provided as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'CheckName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the channel variable to check.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + ], + [ + 'name' => 'CheckValue', + 'in' => 'query', + 'schema' => ['description' => 'The value to compare with the channel variable specified in `CheckName`. The interruption is triggered only if the values match.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], ], 'responses' => [ @@ -6318,102 +4948,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The request status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'QueryVideoPlayProgress', - ], - 'UpgradeVideoFile' => [ - 'summary' => 'Upgrades from a voice call to a video call.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudInterruptIvr', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListAgentGroup' => [ + 'summary' => 'Queries a list of agent groups.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '217976', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '116012354148^10281378****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'MediaType', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'video', - 'default' => 'VIDEO', - ], + 'schema' => ['description' => 'The index of the first entry to return. The value must be greater than or equal to `0`. The default value is `0`.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '225869*****', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values: `1` to `1000`. Default value: `10`.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1590****000', - ], + 'schema' => ['description' => 'The agent group name used to filter the query results.', 'type' => 'string', 'required' => false, 'example' => 'gpName', 'title' => ''], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['description' => 'The agent group ID used to filter the query results.', 'type' => 'string', 'required' => false, 'example' => 'WH123', 'title' => ''], ], ], 'responses' => [ @@ -6421,102 +5022,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', + 'properties' => [ + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChildGnos' => ['description' => 'The IDs of child agent groups.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'CtiLinkAgentGroup' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The agent group name.', 'type' => 'string', 'example' => 'gpname1', 'title' => ''], + 'Comment' => ['description' => 'The description.', 'type' => 'string', 'example' => 'comment1', 'title' => ''], + 'Type' => ['description' => 'The agent group type. Valid values: `1` (main group) and `2` (child group).', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'Gno' => ['description' => 'The agent group ID.', 'type' => 'string', 'example' => 'ZO874912', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600', 'title' => ''], + ], + 'example' => '', + 'description' => 'The agent group information.', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The list of agent groups.', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpgradeVideoFile', - ], - 'DegradeVideoFile' => [ - 'summary' => 'Downgrades from a video call to a voice call.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListAgentGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ChildGnos\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CtiLinkAgentGroup\\": {\\n \\"GroupName\\": \\"gpname1\\",\\n \\"Comment\\": \\"comment1\\",\\n \\"Type\\": 2,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Gno\\": \\"ZO874912\\",\\n \\"EnterpriseId\\": 7122600\\n }\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListAgentTel' => [ + 'summary' => 'Queries an agent\'s phone information.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '217975', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '116012354148^1028137841****', - ], - ], - [ - 'name' => 'MediaType', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'video', - 'default' => 'AUDIO', - ], + 'schema' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7122600', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '225869*****', - ], + 'schema' => ['description' => 'The agent ID. The ID must be a string of 3 to 10 digits.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'Tel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1590****000', - ], + 'schema' => ['description' => 'The agent phone number.', 'type' => 'string', 'required' => false, 'example' => '41008502', 'title' => ''], ], ], 'responses' => [ @@ -6524,102 +5114,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], + 'AccessDeniedDetail' => ['description' => 'The reason access was denied.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'A list of agent phone details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsBind' => ['description' => 'Whether the phone number is bound. Valid values: `0` (Unbound) and `1` (Bound).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '7098', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'Tel' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '41008502', 'title' => ''], + 'Id' => ['description' => 'The agent phone ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'AgentId' => ['description' => 'The unique ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], + 'TelType' => ['description' => 'The phone type. Valid values: `1` (landline), `2` (mobile phone), `3` (extension number), and `4` (softphone).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'IsValidity' => ['description' => 'Whether the phone number is verified. Valid values: `0` (Unverified) and `1` (Verified).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The data.', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- `OK` indicates the request was successful.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DegradeVideoFile', - ], - 'SkipVideoFile' => [ - 'summary' => 'Fast forwards or rewinds a video when you play the video.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListAgentTel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"IsBind\\": 1,\\n \\"Cno\\": \\"7098\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"Tel\\": \\"41008502\\",\\n \\"Id\\": 9,\\n \\"AgentId\\": 19,\\n \\"TelType\\": 1,\\n \\"IsValidity\\": 1,\\n \\"EnterpriseId\\": 7122600\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListAssignedAgentGroup' => [ + 'summary' => 'Lists the agents in a specified outbound call group.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '218113', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'SkipTimes', + 'name' => 'Gno', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '04:02:01', - ], + 'schema' => ['description' => 'The outbound call group number.', 'type' => 'string', 'required' => true, 'example' => 'WH113', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PR0210428****', - ], + 'schema' => ['description' => 'The agent number. Use this parameter to filter the results.', 'type' => 'string', 'required' => false, 'example' => '111111111', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'Cname', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1590****000', - ], + 'schema' => ['description' => 'The agent name. Use this parameter to filter the results.', 'type' => 'string', 'required' => false, 'example' => '111111111', 'title' => ''], ], ], 'responses' => [ @@ -6627,82 +5210,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], + 'AccessDeniedDetail' => ['description' => 'Deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'The list of agents.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Cno' => ['description' => 'The agent number.', 'type' => 'string', 'example' => '59517582', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-03-30 06:12:30', 'title' => ''], + 'Gno' => ['description' => 'The outbound call group number.', 'type' => 'string', 'example' => 'ZO874912', 'title' => ''], + 'Cname' => ['description' => 'The agent name.', 'type' => 'integer', 'format' => 'int64', 'example' => 'name1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The ID of the call center.', 'type' => 'string', 'example' => '7122600', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'SkipVideoFile', - ], - 'GetCallMediaType' => [ - 'summary' => 'Obtains the call type during a call.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListAssignedAgentGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Cno\\": \\"59517582\\",\\n \\"CreateTime\\": \\"2026-03-30 06:12:30\\",\\n \\"Gno\\": \\"ZO874912\\",\\n \\"Cname\\": 0,\\n \\"EnterpriseId\\": \\"7122600\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListCurlLog' => [ + 'summary' => 'Query user push logs.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1580000****', - ], + 'schema' => ['description' => 'The push type. Valid values: 1: Inbound call, 2: Inbound call ringing, 3: Outbound call ringing, 4: WebCall transfer to agent ringing, 5: Inbound call connected, 6: Outbound call connected, 7: Inbound call hang-up, 8: Outbound call hang-up, 9: Agent status, 10: Keypress, 11: Number status detection, 12: Recording status, 13: HTTP interaction, 14: Predictive outbound call task, 15: ASR result, 16: WebCall customer-side ringing, 17: Customer satisfaction survey, 18: Predictive outbound call customer answer status, 19: NLU, 20: Predictive outbound call both parties connected, 21: IVR interaction end, 22: Outbound call customer ringing, 23: WebCall customer answered, 24: WebCall transfer ringing, 25: WebCall transfer connected, 26: Agent-initiated outbound call extension ringing, 27: Agent-initiated outbound call extension answered, 28: Agent-initiated outbound call customer ringing, 29: Agent-initiated outbound call both parties connected.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Result', + 'in' => 'query', + 'schema' => ['description' => 'The push result. Valid values: 1: Success, 0: Failed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => ['description' => 'The destination URL.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the query\'s start time in yyyy-MM-dd HH:mm:ss format. The time range between StartTime and EndTime must be within the same month. If unspecified, the default is the first day of the current month.', 'type' => 'string', 'required' => true, 'example' => '2026-04-20 10:00:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the query\'s end time in yyyy-MM-dd HH:mm:ss format. The time range between StartTime and EndTime must be within the same month. If unspecified, the default is the last day of the current month.', 'type' => 'string', 'required' => true, 'example' => '2026-04-23 10:00:00', 'title' => ''], + ], + [ + 'name' => 'Retry', + 'in' => 'query', + 'schema' => ['description' => 'The number of retries. The default is -2.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The pagination offset. The value must be 0 or greater. Default: 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page. Value range: 1–500. Default: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -6710,73 +5322,144 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated. Ignore it.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'properties' => [ + 'List' => [ + 'description' => 'The array of log objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UniqueId' => ['description' => 'The unique ID of the push operation.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the push operation.', 'type' => 'string', 'example' => '1774822137959', 'title' => ''], + 'ContentType' => ['description' => 'The content type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Position' => ['description' => 'The push position.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Timeout' => ['description' => 'The request timeout.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Headers' => ['description' => 'The request headers.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the log entry.', 'type' => 'string', 'example' => '1774822134415', 'title' => ''], + 'TypeStr' => ['description' => 'The push type, represented as a string.', 'type' => 'string', 'example' => '主通话记录推送', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the push operation.', 'type' => 'string', 'example' => '1774822134132', 'title' => ''], + 'Params' => ['description' => 'The push parameters.', 'type' => 'string', 'example' => '{\\"bindTel\\":\\"01041000229\\",\\"stateAction\\":\\"idle\\",\\"cno\\":\\"8702\\",\\"bindType\\":\\"1\\",\\"enterpriseId\\":\\"7122600\\",\\"state\\":\\"空闲\\",\\"timeInMillis\\":\\"1774822137188\\",\\"time\\":\\"1774822137\\",\\"event\\":\\"status\\",\\"loginStatus\\":\\"1\\",\\"deviceStatus\\":\\"0\\"}', 'title' => ''], + 'RequestTime' => ['description' => 'The request time.', 'type' => 'string', 'example' => '1774822137191', 'title' => ''], + 'Method' => ['description' => 'The HTTP method used for the push request.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'StatusCode' => ['description' => 'The status code returned by the destination server.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Url' => ['description' => 'The destination URL for the push.', 'type' => 'string', 'example' => 'https://www.aaa.com/index.htm', 'title' => ''], + 'Delay' => ['description' => 'The push delay.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7122600', 'title' => ''], + 'Result' => ['description' => 'The push status.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The push type.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'ResultText' => ['description' => 'The result text returned by the destination server.', 'type' => 'string', 'example' => '{\\"stateAction\\":\\"busyAgentOb\\",\\"cno\\":\\"8702\\",\\"bindType\\":\\"1\\",\\"timeInMillis\\":\\"1774822133193\\",\\"loginStatus\\":\\"1\\",\\"customerNumber\\":\\"01042000229\\",\\"callType\\":\\"4\\",\\"deviceStatus\\":\\"4\\",\\"bindTel\\":\\"01041000229\\",\\"mainUniqueId\\":\\"sip-33-1774822127.355\\",\\"enterpriseId\\":\\"7122600\\",\\"state\\":\\"通话\\",\\"time\\":\\"1774822133\\",\\"event\\":\\"status\\",\\"uniqueId\\":\\"sip-33-1774822127.355\\"}', 'title' => ''], + 'Level' => ['description' => 'The push level.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Retry' => ['description' => 'The retry count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The log ID.', 'type' => 'string', 'example' => '12715', 'title' => ''], + 'CurrentMonth' => ['description' => 'The current month.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code of the response.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListCurlLog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetCallMediaType', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"UniqueId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"EndTime\\": \\"1774822137959\\",\\n \\"ContentType\\": 1,\\n \\"Position\\": \\"0\\",\\n \\"Timeout\\": \\"3\\",\\n \\"Headers\\": \\"{}\\",\\n \\"CreateTime\\": \\"1774822134415\\",\\n \\"TypeStr\\": \\"主通话记录推送\\",\\n \\"StartTime\\": \\"1774822134132\\",\\n \\"Params\\": \\"{\\\\\\\\\\\\\\"bindTel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01041000229\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"stateAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cno\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8702\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bindType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enterpriseId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"7122600\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"state\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"空闲\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeInMillis\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822137188\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822137\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"event\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"loginStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"deviceStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"}\\",\\n \\"RequestTime\\": \\"1774822137191\\",\\n \\"Method\\": \\"GET\\",\\n \\"StatusCode\\": \\"200\\",\\n \\"Url\\": \\"https://www.aaa.com/index.htm\\",\\n \\"Delay\\": 0,\\n \\"EnterpriseId\\": \\"7122600\\",\\n \\"Result\\": \\"1\\",\\n \\"Type\\": 9,\\n \\"ResultText\\": \\"{\\\\\\\\\\\\\\"stateAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"busyAgentOb\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cno\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8702\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bindType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeInMillis\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822133193\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"loginStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"customerNumber\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01042000229\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"callType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"deviceStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bindTel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01041000229\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mainUniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sip-33-1774822127.355\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enterpriseId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"7122600\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"state\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"通话\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822133\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"event\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sip-33-1774822127.355\\\\\\\\\\\\\\"}\\",\\n \\"Level\\": 0,\\n \\"Retry\\": 0,\\n \\"Id\\": \\"12715\\",\\n \\"CurrentMonth\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'GetTemporaryFileUrl' => [ - 'summary' => 'Obtains a temporary URL of a video or audio file. You can view the video or audio file immediately by using this temporary URL.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudListExten' => [ + 'summary' => 'Returns a list of extensions.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'VideoId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '45a04670582571eebf9e4531948c****', - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Exten', + 'in' => 'query', + 'schema' => ['description' => 'The extension number.', 'type' => 'string', 'required' => false, 'example' => '9000', 'title' => ''], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['description' => 'The call permission. Valid values: `0` (unrestricted), `1` (domestic long-distance), `2` (local), and `3` (internal calls). The default value is `0`.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether outbound calls are allowed. Valid values: `1` (allowed) and `0` (disallowed). The default value is `1`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether to record inbound calls. Valid values: `1` (enabled) and `0` (disabled). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether to record outbound calls. Valid values: `1` (enabled) and `0` (disabled). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['description' => 'The area code.', 'type' => 'string', 'required' => false, 'example' => '010', 'title' => ''], + ], + [ + 'name' => 'JitterBuffer', + 'in' => 'query', + 'schema' => ['description' => 'The jitter buffer setting.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The registration type. Valid values: `1` (IAD extension), `2` (WebRTC), and `3` (remote phone).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'IsBind', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether the extension is bound to an agent. Valid values: `1` (bound) and `0` (unbound). The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of extensions to return per page. Valid values: 1 to 500. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to skip for pagination. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -6784,146 +5467,165 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7BF47617-7851-48F7-A3A1-2021342A****', - ], + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'type' => 'object', + 'properties' => [ + 'OrderBy' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'exten', 'title' => ''], + 'NavigatepageNums' => [ + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'example' => '', + 'description' => 'This parameter is deprecated.', + 'title' => '', + ], + 'FirstPage' => ['description' => 'The first page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PrePage' => ['description' => 'The previous page number.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PageNum' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'EndRow' => ['description' => 'The end row number.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'IsLastPage' => ['description' => 'Indicates whether the current page is the last page.', 'type' => 'integer', 'format' => 'int64', 'example' => 'true', 'title' => ''], + 'Size' => ['description' => 'The number of entries on the current page.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'IsFirstPage' => ['description' => 'Indicates whether the current page is the first page.', 'type' => 'integer', 'format' => 'int64', 'example' => 'true', 'title' => ''], + 'HasPreviousPage' => ['description' => 'Indicates whether a previous page exists.', 'type' => 'integer', 'format' => 'int64', 'example' => 'true', 'title' => ''], + 'StartRow' => ['description' => 'The start row number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Pages' => ['description' => 'The total number of pages.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'NavigatePages' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Total' => ['description' => 'The total count of entries.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JitterBuffer' => ['description' => 'The jitter buffer.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CallPower' => ['description' => 'The calling permission level. Valid values: `0` (unrestricted), `1` (domestic long-distance), `2` (local), and `3` (internal). The default value is `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-03-30 06:09:02', 'title' => ''], + 'IbRecord' => ['description' => 'Indicates whether to record inbound calls. Valid values: `0` (do not record) and `1` (record). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Exten' => ['description' => 'The extension number. The value must be 3 to 11 digits in length.', 'type' => 'string', 'example' => '66749', 'title' => ''], + 'ObRecord' => ['description' => 'Indicates whether to record outbound calls. Valid values: `0` (do not record) and `1` (record). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Allow' => ['description' => 'The allowed voice codecs. Supported combinations: 1. `g729` 2. `g729,alaw,ulaw` 3. `alaw,ulaw,g729` 4. `alaw,ulaw` 5. `myopus,alaw,ulaw`. The valid combination depends on the network and phone type: public network + remote phone (1, 2, 3); dedicated line + remote phone (1, 2); public network + softphone (4); dedicated line + softphone (5).', 'type' => 'string', 'example' => 'alaw,ulaw', 'title' => ''], + 'Type' => ['description' => 'The device registration type. Valid values: `1` for an IAD extension, `2` for WebRTC, and `3` for a remote phone.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'Denoise' => ['description' => 'Indicates whether to enable noise reduction. Valid values: `0` (disabled) and `1` (enabled). The default value is `0`. This parameter takes effect only when `Type` is set to `2`.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The ID of the extension.', 'type' => 'integer', 'format' => 'int64', 'example' => '59', 'title' => ''], + 'IsDirect' => ['description' => 'Indicates whether off-hook outbound calls are allowed. Valid values: `0` (disallowed) and `1` (allowed). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => 'Aa626670', 'title' => ''], + 'IsOb' => ['description' => 'Indicates whether outbound calls are allowed. Valid values: `0` (disallowed) and `1` (allowed). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The list of extensions.', + 'title' => '', + ], + 'NextPage' => ['description' => 'The next page number.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'LastPage' => ['description' => 'The last page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'HasNextPage' => ['description' => 'Indicates whether a next page exists.', 'type' => 'integer', 'format' => 'int64', 'example' => 'false', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListExten', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A****\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetTemporaryFileUrl', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OrderBy\\": \\"exten\\",\\n \\"NavigatepageNums\\": [\\n \\"1\\"\\n ],\\n \\"FirstPage\\": \\"1\\",\\n \\"PrePage\\": \\"0\\",\\n \\"PageNum\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"EndRow\\": \\"3\\",\\n \\"IsLastPage\\": 0,\\n \\"Size\\": \\"3\\",\\n \\"IsFirstPage\\": 0,\\n \\"HasPreviousPage\\": 0,\\n \\"StartRow\\": \\"1\\",\\n \\"Pages\\": \\"1\\",\\n \\"NavigatePages\\": \\"example\\",\\n \\"Total\\": \\"3\\",\\n \\"List\\": [\\n {\\n \\"JitterBuffer\\": 0,\\n \\"CallPower\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-03-30 06:09:02\\",\\n \\"IbRecord\\": 1,\\n \\"Exten\\": \\"66749\\",\\n \\"ObRecord\\": 1,\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Allow\\": \\"alaw,ulaw\\",\\n \\"Type\\": 2,\\n \\"AreaCode\\": \\"010\\",\\n \\"Denoise\\": 0,\\n \\"Id\\": 59,\\n \\"IsDirect\\": 1,\\n \\"Password\\": \\"Aa626670\\",\\n \\"IsOb\\": 1\\n }\\n ],\\n \\"NextPage\\": \\"0\\",\\n \\"LastPage\\": \\"1\\",\\n \\"HasNextPage\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'GetToken' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudListFreeAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '52685', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TokenType', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The token type.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'dyvms', - 'minLength' => 0, - ], + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'* The value OK indicates that the request was successful.'."\n" - .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Token' => [ - 'description' => 'The token.'."\n", - 'type' => 'string', - 'example' => 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'AccessDeniedDetail' => ['description' => 'Details for the access denied status.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'Name' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '李四', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The list of agents.', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- OK indicates that the request was successful.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListFreeAgent', + 'summary' => 'Lists online agents.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Token\\": \\"eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\nD9CB3933-9FE3-4870-BA8E-2BEE91B69DDD\\neyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZiI6MTYyMzM5NDQ2Ny****\\nOK\\ntrue\\n","errorExample":""}]', - 'title' => 'GetToken', - 'summary' => 'Obtains the token for authentication.', - 'description' => '### QPS limits'."\n" - ."\n" - .'You can call this operation up to five times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Cno\\": \\"1111\\",\\n \\"Name\\": \\"李四\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'RecoverCallInConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudListOnlineAgent' => [ + 'summary' => 'Lists online agents.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6931,78 +5633,104 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Number', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The China 400 number that is used to transfer the inbound call.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '400***', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Qnos', + 'in' => 'query', + 'schema' => ['description' => 'The queue numbers. Specify one or more queue numbers to filter agents by queue. Separate multiple queue numbers with a comma (,). If you do not specify this parameter, the API returns agents from all queues.', 'type' => 'string', 'required' => false, 'example' => '123,124', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'The agent IDs. You can specify one or more agent IDs to retrieve information for specific agents. Separate multiple agent IDs with a comma (,). If you do not specify this parameter, the API returns information for all agents under the current account.', 'type' => 'string', 'required' => false, 'example' => '1111,1112', 'title' => ''], + ], + [ + 'name' => 'StateCode', + 'in' => 'query', + 'schema' => ['description' => 'The agent state. Use this parameter to filter agents by their current state. Separate multiple states with a comma (,). Valid values include `s1` for Idle, `s2` for Paused, `s3` for Wrap-up, `s4` for Calling, `s5` for Ringing, and `s6` for On a call.', 'type' => 'string', 'required' => false, 'example' => 's1', 'title' => ''], + ], + [ + 'name' => 'PauseType', + 'in' => 'query', + 'schema' => ['description' => 'The pause type. Use this parameter to filter agents based on their pause type. You can specify multiple pause types, separated by a comma (,).
Valid values: `1` for Normal, `2` for Break, `3` for IM, and `4` for Forced.
', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PauseDescription', + 'in' => 'query', + 'schema' => ['description' => 'The pause reason. Use this parameter to filter agents based on the reason they are paused. You can specify multiple pause reasons, separated by a comma (,). If you omit this parameter, the query returns all paused agents regardless of the reason.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainApiResponse', - 'description' => 'PlainApiResponse'."\n", 'type' => 'object', 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the inbound call was resumed. Valid values:'."\n" - ."\n" - .'* true: The inbound call was resumed.'."\n" - .'* false: The inbound call failed to be resumed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'AgentStatuses' => [ + 'description' => 'An array of agent statuses.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LoginStatusDuration' => ['description' => 'The duration of the current login status, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'LoginTime' => ['description' => 'The agent\'s login timestamp.', 'type' => 'string', 'example' => '1774821736', 'title' => ''], + 'DeviceStatusDuration' => ['description' => 'The duration of the current device status, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'State' => ['description' => 'The overall agent state, which is a combination of the login and device statuses. Possible values: Inactive, Idle, Paused, Wrap-up, Calling, Ringing, and On a call.', 'type' => 'string', 'example' => '空闲', 'title' => ''], + 'LoginStatus' => ['description' => 'The agent\'s login status. Valid values: `0` for Offline, `1` for Online, `2` for Paused, and `3` for Wrap-up.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DeviceStatus' => ['description' => 'The agent\'s device status. Valid values: `-1` for Inactive, `0` for Idle, `1` for Locked, `2` for Calling, `3` for Ringing, and `4` for On a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'BindTel' => ['description' => 'The agent\'s bound phone number.', 'type' => 'string', 'example' => '22223333', 'title' => ''], + 'Name' => ['description' => 'The agent\'s name.', 'type' => 'string', 'example' => '李四', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- A value of `OK` indicates that the request was successful.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListOnlineAgent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', - 'title' => 'RecoverCallInConfig', - 'summary' => 'Resumes the inbound call that is transferred by using a China 400 number.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AgentStatuses\\": [\\n {\\n \\"LoginStatusDuration\\": 7,\\n \\"LoginTime\\": \\"1774821736\\",\\n \\"DeviceStatusDuration\\": 0,\\n \\"Cno\\": \\"1111\\",\\n \\"State\\": \\"空闲\\",\\n \\"LoginStatus\\": 1,\\n \\"DeviceStatus\\": 0,\\n \\"BindTel\\": \\"22223333\\",\\n \\"Name\\": \\"李四\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'StopCallInConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudListQueue' => [ + 'summary' => 'Gets a list of queues.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7010,109 +5738,144 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '135026', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Number', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The China 400 number from which the inbound call to be stopped is transferred.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '400***', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page. The value must be an integer from 1 to 500. The default value is 500.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', 'title' => ''], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to skip before returning results. The value must be a non-negative integer. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['description' => 'The queue number.', 'type' => 'string', 'required' => false, 'example' => '233', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the queue.', 'type' => 'string', 'required' => false, 'example' => '描述', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order by creation time. Valid values: `0` (ascending) and `1` (descending).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the creation time range for the query. The time must be in the `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the creation time range for the query. The time must be in the `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 23:00:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainApiResponse', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the inbound call was stopped. Valid values:'."\n" - ."\n" - .'* true: The inbound call was stopped.'."\n" - .'* false: The inbound call failed to be stopped.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of queues.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], + 'List' => [ + 'description' => 'A list of queues.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['description' => 'The service level threshold, in seconds. Calls answered within this period are considered to have a high service level.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'AnnounceSound' => ['description' => 'Specifies whether to play a fixed announcement. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'WrapupTime' => ['description' => 'The wrap-up time, in seconds. Valid values: 3 to 3600.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'MaxLen' => ['description' => 'The maximum number of callers in the queue. Valid values: 0 to 999. A value of `0` indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'queueName', 'title' => ''], + 'AnnouncePosition' => ['description' => 'Specifies when to announce the caller\'s position in the queue. Valid values: `0` (disabled), `1` (announce when position > `AnnouncePositionParam`), and `2` (announce when position <= `AnnouncePositionParam`).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnounceSoundFile' => ['description' => 'The audio file for the fixed announcement.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'CreateTime' => ['description' => 'The time the queue was created, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2025-09-06 15:50:18', 'title' => ''], + 'QueueTimeout' => ['description' => 'The queue timeout, in seconds. Valid values: 5 to 600. Default value: 600.', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''], + 'AnnounceSoundFrequency' => ['description' => 'The playback interval for the fixed announcement, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionYouarenext' => ['description' => 'Specifies whether to announce "You are next." Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionParam' => ['description' => 'The threshold for the queue position announcement.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'MemberTimeout' => ['description' => 'The agent timeout, in seconds. Valid values: 20 to 60. Default value: 25.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'Weight' => ['description' => 'The queue priority. Valid values: 1 to 10. A higher value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'JoinEmpty' => ['description' => 'Specifies the conditions for joining a queue with no available agents. Valid values: `1` (Busy), `2` (In a call), `4` (Ringing), `8` (Invalid), and `16` (Wrap-up).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + 'Qno' => ['description' => 'The queue number.', 'type' => 'string', 'example' => '33', 'title' => ''], + 'MusicClass' => ['description' => 'The hold music class.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Strategy' => ['description' => 'The routing strategy. Valid values: `rrordered` (Skill Priority), `rrmemory` (Round Robin), `fewestcalls` (Fewest Calls), `random` (Random), `linear` (Linear), and `leastrecent` (Longest Idle Time).', 'type' => 'string', 'example' => 'rrmemory', 'title' => ''], + 'Id' => ['description' => 'The queue ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '48175', 'title' => ''], + 'Retry' => ['description' => 'The delay, in seconds, before routing the call to the next agent if the current agent does not answer.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SayAgentno' => ['description' => 'Specifies whether to announce the agent number. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VipSupport' => ['description' => 'Specifies whether VIP support is enabled. `1`: enabled. `0`: disabled.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnnouncePositionFrequency' => ['description' => 'The announcement interval for the queue position, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListQueue', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', - 'title' => 'StopCallInConfig', - 'summary' => 'Stops the inbound call that is transferred from a China 400 number.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Total\\": 23,\\n \\"List\\": [\\n {\\n \\"ServiceLevel\\": 10,\\n \\"AnnounceSound\\": 0,\\n \\"WrapupTime\\": 10,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queueName\\",\\n \\"AnnouncePosition\\": 0,\\n \\"AnnounceSoundFile\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2025-09-06 15:50:18\\",\\n \\"QueueTimeout\\": 600,\\n \\"AnnounceSoundFrequency\\": 0,\\n \\"AnnouncePositionYouarenext\\": 0,\\n \\"AnnouncePositionParam\\": 0,\\n \\"MemberTimeout\\": 25,\\n \\"Weight\\": 1,\\n \\"JoinEmpty\\": 0,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"33\\",\\n \\"MusicClass\\": \\"default\\",\\n \\"Strategy\\": \\"rrmemory\\",\\n \\"Id\\": 48175,\\n \\"Retry\\": 1,\\n \\"SayAgentno\\": false,\\n \\"VipSupport\\": 0,\\n \\"AnnouncePositionFrequency\\": 0\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'CancelCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudListQueueSkill' => [ + 'summary' => 'Retrieves queue skill information.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['description' => 'The queue number.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ @@ -7120,141 +5883,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'An array of queue skill objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Qno' => ['description' => 'The queue number.', 'type' => 'integer', 'format' => 'int64', 'example' => '26', 'title' => ''], + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the queue-skill mapping. The format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'QueueId' => ['description' => 'The queue ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], + 'SkillId' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '44', 'title' => ''], + 'Id' => ['description' => 'The ID of the queue-skill mapping.', 'type' => 'integer', 'format' => 'int64', 'example' => '93', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListQueueSkill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\tOK\\r\\n\\tOK\\r\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'CancelCall', - 'summary' => 'Cancels the two-way call that is initiated by calling the ClickToDial operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Qno\\": 26,\\n \\"SkillLevel\\": 5,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueId\\": 33,\\n \\"SkillId\\": 44,\\n \\"Id\\": 93,\\n \\"EnterpriseId\\": 7000002\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryVmsVirtualNumberRelationByPage' => [ - 'summary' => '查询虚拟号码与真实号码绑定关系列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CloudListSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '81', - ], - ], - [ - 'name' => 'PageNo', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'VirtualNumber', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '虚拟号码', - 'description' => '虚拟号码', - 'type' => 'string', - 'required' => false, - 'example' => '0571****1234', - ], + 'schema' => ['description' => 'The skill name.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], ], [ - 'name' => 'RealNumber', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'title' => '真实号码', - 'description' => '真实号码', - 'type' => 'string', - 'required' => false, - 'example' => '131***1234', - ], + 'schema' => ['description' => 'The skill description.', 'type' => 'string', 'required' => false, 'example' => 'comment1', 'title' => ''], ], [ - 'name' => 'State', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'title' => '状态 1:有效；0:无效；-1:注销', - 'description' => '状态 1:有效；0:无效；-1:注销', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The maximum number of skills to return. The value must be a positive integer. Default value: 10. Maximum value: 500.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'NumberCity', + 'name' => 'Offset', 'in' => 'query', - 'schema' => [ - 'title' => '号码归属地--城市', - 'description' => '号码归属地--城市', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The starting position for pagination. The value must be a non-negative integer. Default value: 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'NumberProvince', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'title' => '号码归属地--省', - 'description' => '号码归属地--省', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The sort order of skills by creation time. Valid values: 0 (ascending order) and 1 (descending order).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -7262,170 +5981,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => '01A58FA5-422C-58E0-AA71-B307A665416F', - ], - 'Message' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'title' => '', - 'description' => '', + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '65', - ], - 'Total' => [ - 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '231', - ], - 'PageNo' => [ + 'OrderBy' => ['description' => 'The sort field.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'NavigatepageNums' => [ + 'type' => 'array', + 'items' => ['description' => 'You can ignore this parameter.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'example' => '', + 'description' => 'You can ignore this parameter.', 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', ], - 'Data' => [ - 'title' => '', - 'description' => '', + 'FirstPage' => ['description' => 'The first page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PrePage' => ['description' => 'The previous page number.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PageNum' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'EndRow' => ['description' => 'The row number of the last entry on the current page.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'IsLastPage' => ['description' => 'Indicates whether the current page is the last page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Size' => ['description' => 'The number of entries on the current page.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'IsFirstPage' => ['description' => 'Indicates whether the current page is the first page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HasPreviousPage' => ['description' => 'Indicates whether a previous page exists.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'StartRow' => ['description' => 'The row number of the first entry on the current page.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Pages' => ['description' => 'The total number of pages.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'NavigatePages' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'Total' => ['description' => 'The total count of entries.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'List' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RealNumber' => [ - 'title' => '真实号码', - 'description' => '真实号码', - 'type' => 'string', - 'example' => '131****1234', - ], - 'VirtualNumber' => [ - 'title' => '虚拟号码', - 'description' => '虚拟号码', - 'type' => 'string', - 'example' => '0571***1234', - ], - 'State' => [ - 'title' => '状态 1:有效；0:无效；-1:注销', - 'description' => '状态 1:有效；0:无效；-1:注销', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NumberCity' => [ - 'title' => '号码归属地--城市', - 'description' => '号码归属地--城市', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'NumberProvince' => [ - 'title' => '号码归属地--省', - 'description' => '号码归属地--省', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'Comment' => ['description' => 'The description of the skill.', 'type' => 'string', 'example' => '描述', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the skill was created, accurate to the second.', 'type' => 'string', 'example' => '2026-03-30 06:12:41', 'title' => ''], + 'Id' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '52593', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600', 'title' => ''], + 'Name' => ['description' => 'The skill name.', 'type' => 'string', 'example' => '2902JnD更新技能', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'example' => '', + 'description' => 'The skill list.', + 'title' => '', ], + 'NextPage' => ['description' => 'The next page number.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'LastPage' => ['description' => 'The last page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'HasNextPage' => ['description' => 'Indicates whether a next page exists.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => '', - ], - 'Code' => [ + 'description' => 'The response data.', 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListSkill', + 'summary' => 'Gets a list of skills.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"01A58FA5-422C-58E0-AA71-B307A665416F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"PageSize\\": 65,\\n \\"Total\\": 231,\\n \\"PageNo\\": 1,\\n \\"Data\\": [\\n {\\n \\"RealNumber\\": \\"131****1234\\",\\n \\"VirtualNumber\\": \\"0571***1234\\",\\n \\"State\\": 1,\\n \\"NumberCity\\": \\"北京\\",\\n \\"NumberProvince\\": \\"北京\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OrderBy\\": \\"\\\\\\"\\\\\\"\\",\\n \\"NavigatepageNums\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"FirstPage\\": \\"1\\",\\n \\"PrePage\\": \\"0\\",\\n \\"PageNum\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"EndRow\\": \\"4\\",\\n \\"IsLastPage\\": true,\\n \\"Size\\": \\"4\\",\\n \\"IsFirstPage\\": true,\\n \\"HasPreviousPage\\": false,\\n \\"StartRow\\": \\"1\\",\\n \\"Pages\\": \\"1\\",\\n \\"NavigatePages\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Total\\": \\"4\\",\\n \\"List\\": [\\n {\\n \\"Comment\\": \\"描述\\",\\n \\"CreateTime\\": \\"2026-03-30 06:12:41\\",\\n \\"Id\\": 52593,\\n \\"EnterpriseId\\": 7122600,\\n \\"Name\\": \\"2902JnD更新技能\\"\\n }\\n ],\\n \\"NextPage\\": \\"0\\",\\n \\"LastPage\\": \\"1\\",\\n \\"HasNextPage\\": true\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryVmsRealNumberCallConnectionRateInfo' => [ - 'summary' => '查询真实号接通率', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CloudListTaskFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'VirtualNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'title' => '虚拟号码', - 'description' => '虚拟号码', - 'type' => 'string', - 'required' => false, - 'example' => '0571***1234', - ], + 'schema' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], ], [ - 'name' => 'RealNumber', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '真实号码', - 'description' => '真实号码', - 'type' => 'string', - 'required' => false, - 'example' => '131***1234', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '27', 'title' => ''], ], [ - 'name' => 'TimePeriod', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '时间段', - 'description' => '时间段', - 'type' => 'string', - 'required' => false, - 'example' => '1764666240123-1764686240567', - ], + 'schema' => ['description' => 'The batch status. Valid values: `0` (Not imported), `1` (Imported), `2` (Loaded to cache), `3` (Calls completed), and 4 (Frozen).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. The time must be in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The time must be in the `yyyy-MM-dd HH:mm:ss` format. The maximum query range is one month.', 'type' => 'string', 'required' => false, 'example' => '2026-05-20 10:00:00', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The starting offset for the query. Valid values: 0 or greater. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return. Maximum value: 5000. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -7433,314 +6107,9078 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => '95B86652-B234-5387-BAC6-E441FR49399F', - ], - 'Message' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Model' => [ - 'title' => '', - 'description' => '', + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ 'type' => 'object', 'properties' => [ - 'RingingRate' => [ - 'title' => '响铃率', - 'description' => '响铃率', - 'type' => 'number', - 'format' => 'double', - 'example' => '25.4222', - ], - 'ResourceId' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RingingCount' => [ - 'title' => '响铃数', - 'description' => '响铃数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ResourceType' => [ - 'title' => 'EcsInstance, EcsDisk, EcsImage, EcsSnapshot, EcsSecurityGroup, EcsEip, EcsVpc, EcsVRouter, EcsVSwitch, EcsVRouteTable, EcsAuthImage, EcsAll, SlbLoadbalancer, SlbVm, RdsInstance, RdsAllInstance, KvsInstance, OcsInstance, OdpsInstance', - 'description' => 'EcsInstance, EcsDisk, EcsImage, EcsSnapshot, EcsSecurityGroup, EcsEip, EcsVpc, EcsVRouter, EcsVSwitch, EcsVRouteTable, EcsAuthImage, EcsAll, SlbLoadbalancer, SlbVm, RdsInstance, RdsAllInstance, KvsInstance, OcsInstance, OdpsInstance', - 'type' => 'string', - 'example' => '示例值', - ], - 'RegionId' => [ + 'TotalCount' => ['description' => 'The total number of call task batches.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TaskFileList' => [ + 'description' => 'A list of call task batches.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The batch status. Valid values: `0` (Not imported), `1` (Imported), `2` (Loaded to cache), `3` (Calls completed), and `4` (Frozen).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'RepeatCount' => ['description' => 'The number of duplicate entries.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '27', 'title' => ''], + 'RestrictCount' => ['description' => 'The blacklist count.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ImportCount' => ['description' => 'The number of imported entries.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Priority' => ['description' => 'The batch priority. Default value: 0. A higher value indicates a higher priority.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the batch, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'Id' => ['description' => 'The batch ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The batch name.', 'type' => 'string', 'example' => 'name2', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallConnectionRate' => [ - 'title' => '接通率', - 'description' => '接通率', - 'type' => 'number', - 'format' => 'double', - 'example' => '6.71672', - ], - 'RequestCount' => [ - 'title' => '请求通话数', - 'description' => '请求通话数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'CompleteCount' => [ - 'title' => '接通数', - 'description' => '接通数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52', ], ], - 'example' => '', - ], - 'Code' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ + 'description' => 'The response data.', 'title' => '', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', ], + 'Code' => ['description' => 'The status code. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudListTaskFile', + 'summary' => 'Retrieves a list of call task batches.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"95B86652-B234-5387-BAC6-E441FR49399F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"RingingRate\\": 25.4222,\\n \\"ResourceId\\": \\"无\\",\\n \\"RingingCount\\": 3,\\n \\"ResourceType\\": \\"无\\",\\n \\"RegionId\\": \\"无\\",\\n \\"CallConnectionRate\\": 6.71672,\\n \\"RequestCount\\": 49,\\n \\"CompleteCount\\": 52\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-gov-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-nu16-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-edge-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fujian', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-haidian-cm12-c01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"TaskFileList\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"RepeatCount\\": \\"0\\",\\n \\"TaskId\\": \\"27\\",\\n \\"RestrictCount\\": \\"0\\",\\n \\"ImportCount\\": \\"3\\",\\n \\"Priority\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name2\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-bj-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudMonitorTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The outbound task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'RemovedAgentStatisticList' => [ + 'description' => 'The statistics for removed agents. This parameter is returned only when `includeRemovedAgents=1`.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TodayAnsweredCount' => ['description' => 'The number of calls the agent answered today for this task.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'NoBridgeCount' => ['description' => 'The number of calls the agent did not answer.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'EnterpriseCallLimit' => ['description' => 'At the enterprise level, the maximum number of calls that an agent can answer per day. A value of -1 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + 'Name' => ['description' => 'The agent name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'AvgBridgeTime' => ['description' => 'The average talk time of the agent, in seconds.', 'type' => 'string', 'example' => '39', 'title' => ''], + 'EnterpriseTodayAnsweredCount' => ['description' => 'The number of calls the agent answered today, counted at the enterprise level.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'AgentStatus' => ['description' => 'The current status of the agent. Valid values: `stateIdle` (Idle), `statePause` (Paused), `stateInuse` (On a call), `stateCalling` (Calling), and `stateWrapup` (Wrap-up). An empty value indicates the agent\'s status is not currently relevant to this task, for example, because the agent is not participating in it.', 'type' => 'string', 'example' => 'stateIdle', 'title' => ''], + 'AgentAvgIdleTime' => ['description' => 'The agent\'s average idle time in seconds, calculated by dividing the total idle time by the number of calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], + 'BridgeCount' => ['description' => 'The number of calls answered by the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'CalledCount' => ['description' => 'The number of calls made.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'BridgeIn2sRate' => ['description' => 'The agent\'s auto-answer rate, calculated by dividing the number of calls answered within two seconds of ringing by the total number of answered calls.', 'type' => 'number', 'format' => 'double', 'example' => '3.55', 'title' => ''], + 'CallLimit' => ['description' => 'At the task level, the maximum number of calls that an agent can answer per day. A value of -1 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'TodayStatistic' => [ + 'description' => 'The task\'s monitoring information for today.', + 'type' => 'object', + 'properties' => [ + 'CtiLinkTaskProperty' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the task. Valid values: `0` (Initializing), `1` (Running), `2` (Paused), and `3` (Ended).', 'type' => 'string', 'example' => '2', 'title' => ''], + 'OverTime' => ['description' => 'The task end time.', 'type' => 'string', 'example' => '2026-04-20 11:00:00', 'title' => ''], + 'StatusDescription' => ['description' => 'The description of the task status.', 'type' => 'string', 'example' => '号码呼完', 'title' => ''], + 'StartTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'Id' => ['description' => 'The ID of the outbound call task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12314', 'title' => ''], + 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'testTask', 'title' => ''], + ], + 'example' => '', + 'description' => 'The task properties.', + 'title' => '', + ], + 'AgentCount' => ['description' => 'The number of agents assigned to the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'CalledCount' => ['description' => 'The total number of calls made for the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'AnswerCount' => ['description' => 'The total number of calls answered for the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'UncalledCount' => ['description' => 'The number of contacts for the task that have not yet been called.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CallAgentCount' => ['description' => 'The number of agents who are currently making calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'Statistic' => [ + 'description' => 'The monitoring information for the task.', + 'type' => 'object', + 'properties' => [ + 'CtiLinkTaskProperty' => [ + 'description' => 'The task properties.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the task. Valid values: `0` (Initializing), `1` (Running), `2` (Paused), and `3` (Ended).', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'OverTime' => ['description' => 'The task end time.', 'type' => 'string', 'example' => '2026-04-20 11:00:00', 'title' => ''], + 'StatusDescription' => ['description' => 'The description of the task status.', 'type' => 'string', 'example' => '号码呼完', 'title' => ''], + 'StartTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'Id' => ['description' => 'The ID of the outbound call task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12314', 'title' => ''], + 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'testTask', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'AgentCount' => ['description' => 'The number of agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'CalledCount' => ['description' => 'The number of calls made.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'AnswerCount' => ['description' => 'The number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'UncalledCount' => ['description' => 'The number of calls not made.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CallAgentCount' => ['description' => 'The number of calling agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'AgentStatisticList' => [ + 'description' => 'The agent statistics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TodayAnsweredCount' => ['description' => 'The number of calls the agent answered today for this task.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'NoBridgeCount' => ['description' => 'The number of calls the agent did not answer.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'EnterpriseCallLimit' => ['description' => 'At the enterprise level, the maximum number of calls that an agent can answer per day. A value of -1 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + 'Name' => ['description' => 'The agent name.', 'type' => 'string', 'example' => 'name2', 'title' => ''], + 'AvgBridgeTime' => ['description' => 'The average talk time of the agent, in seconds.', 'type' => 'string', 'example' => '116', 'title' => ''], + 'EnterpriseTodayAnsweredCount' => ['description' => 'The number of calls the agent answered today, counted at the enterprise level.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'AgentStatus' => ['description' => 'The current status of the agent. Valid values: `stateIdle` (Idle), `statePause` (Paused), `stateInuse` (On a call), `stateCalling` (Calling), and `stateWrapup` (Wrap-up). An empty value indicates the agent\'s status is not currently relevant to this task, for example, because the agent is not participating in it.', 'type' => 'string', 'example' => 'stateIdle', 'title' => ''], + 'AgentAvgIdleTime' => ['description' => 'The agent\'s average idle time in seconds, calculated by dividing the total idle time by the number of calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'BridgeCount' => ['description' => 'The number of calls answered by the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CalledCount' => ['description' => 'The number of calls made.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'BridgeIn2sRate' => ['description' => 'The agent\'s auto-answer rate, calculated by dividing the number of calls answered within two seconds of ringing by the total number of answered calls.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'CallLimit' => ['description' => 'At the task level, the maximum number of calls that an agent can answer per day. A value of -1 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'ChannelInfo' => [ + 'description' => 'The channel monitoring information.', + 'type' => 'object', + 'properties' => [ + 'BridgedCount' => ['description' => 'The number of bridged calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'EnterpriseChannelCount' => ['description' => 'The number of predictive outbound channels for the enterprise.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ChannelCount' => ['description' => 'The number of channels that the task is currently using.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'WaitAgentCount' => ['description' => 'The number of calls in the queue waiting for an agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AnswerCount' => ['description' => 'The number of calls answered by customers.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'IvrCount' => ['description' => 'The number of calls that were routed to the IVR (Interactive Voice Response).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'WaitAnswerCount' => ['description' => 'The number of calls waiting for a customer to answer.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'AgentInfo' => [ + 'description' => 'Statistics on agent statuses.', + 'type' => 'object', + 'properties' => [ + 'WrapupCount' => ['description' => 'The number of agents in wrap-up status.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of agents in the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'RingingCount' => ['description' => 'The number of agents whose phones are currently ringing.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'BridgeCount' => ['description' => 'The number of agents who are currently on a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'OnlineCount' => ['description' => 'The number of online agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AvailableCount' => ['description' => 'The number of available agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudMonitorTask', + 'summary' => 'Call task monitoring', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"RemovedAgentStatisticList\\": [\\n {\\n \\"TodayAnsweredCount\\": 3,\\n \\"Cno\\": \\"1111\\",\\n \\"NoBridgeCount\\": 3,\\n \\"EnterpriseCallLimit\\": -1,\\n \\"Name\\": \\"name\\",\\n \\"AvgBridgeTime\\": \\"39\\",\\n \\"EnterpriseTodayAnsweredCount\\": 3,\\n \\"AgentStatus\\": \\"stateIdle\\",\\n \\"AgentAvgIdleTime\\": 13,\\n \\"BridgeCount\\": 3,\\n \\"CalledCount\\": 5,\\n \\"BridgeIn2sRate\\": 3.55,\\n \\"CallLimit\\": -1\\n }\\n ],\\n \\"TodayStatistic\\": {\\n \\"CtiLinkTaskProperty\\": {\\n \\"Status\\": \\"2\\",\\n \\"OverTime\\": \\"2026-04-20 11:00:00\\",\\n \\"StatusDescription\\": \\"号码呼完\\",\\n \\"StartTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": 12314,\\n \\"Name\\": \\"testTask\\"\\n },\\n \\"AgentCount\\": 3,\\n \\"CalledCount\\": 3,\\n \\"AnswerCount\\": 3,\\n \\"UncalledCount\\": 0,\\n \\"CallAgentCount\\": 3\\n },\\n \\"Statistic\\": {\\n \\"CtiLinkTaskProperty\\": {\\n \\"Status\\": 2,\\n \\"OverTime\\": \\"2026-04-20 11:00:00\\",\\n \\"StatusDescription\\": \\"号码呼完\\",\\n \\"StartTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": 12314,\\n \\"Name\\": \\"testTask\\"\\n },\\n \\"AgentCount\\": 2,\\n \\"CalledCount\\": 4,\\n \\"AnswerCount\\": 3,\\n \\"UncalledCount\\": 1,\\n \\"CallAgentCount\\": 3\\n },\\n \\"AgentStatisticList\\": [\\n {\\n \\"TodayAnsweredCount\\": 3,\\n \\"Cno\\": \\"1111\\",\\n \\"NoBridgeCount\\": 0,\\n \\"EnterpriseCallLimit\\": -1,\\n \\"Name\\": \\"name2\\",\\n \\"AvgBridgeTime\\": \\"116\\",\\n \\"EnterpriseTodayAnsweredCount\\": 3,\\n \\"AgentStatus\\": \\"stateIdle\\",\\n \\"AgentAvgIdleTime\\": 0,\\n \\"BridgeCount\\": 0,\\n \\"CalledCount\\": 0,\\n \\"BridgeIn2sRate\\": 0,\\n \\"CallLimit\\": -1\\n }\\n ],\\n \\"ChannelInfo\\": {\\n \\"BridgedCount\\": 0,\\n \\"EnterpriseChannelCount\\": 2,\\n \\"ChannelCount\\": 0,\\n \\"WaitAgentCount\\": 0,\\n \\"AnswerCount\\": 0,\\n \\"IvrCount\\": 0,\\n \\"WaitAnswerCount\\": 0\\n },\\n \\"AgentInfo\\": {\\n \\"WrapupCount\\": 4,\\n \\"TotalCount\\": 2,\\n \\"RingingCount\\": 4,\\n \\"BridgeCount\\": 6,\\n \\"OnlineCount\\": 2,\\n \\"AvailableCount\\": 2\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudOutboundObClidReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['description' => 'The time period type for the report. Valid values: 1: daily report, 2: weekly report, 3: monthly report, and 4: custom time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StatisticMethod', + 'in' => 'query', + 'schema' => ['description' => 'The aggregation method. Valid values: 0: by hour, 1: by day, 2: summary, and 11: trunk group summary.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'AreaCodes', + 'in' => 'query', + 'schema' => ['description' => 'The area codes for which to query statistics about preview outbound calls. Separate multiple codes with a comma (,). If this parameter is omitted, the operation returns statistics for all regions in your account.', 'type' => 'string', 'required' => false, 'example' => '010', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start date of the query, in yyyy-MM-dd format.', 'type' => 'string', 'required' => true, 'example' => '2017-06-13', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end date of the query, in yyyy-MM-dd format.', 'type' => 'string', 'required' => true, 'example' => '2017-06-13', 'title' => ''], + ], + [ + 'name' => 'StartHour', + 'in' => 'query', + 'schema' => ['description' => 'The start hour of the daily time range. Valid values: 0 to 23. The default is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'EndHour', + 'in' => 'query', + 'schema' => ['description' => 'The end hour of the daily time range. Valid values: 0 to 23. The default is 23.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The offset for pagination. The value must be greater than or equal to 0. Defaults to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page. Maximum: 1000. Default: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'A list of data records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClidRate' => ['description' => 'The answer rate for the CLID.', 'type' => 'string', 'example' => '20%', 'title' => ''], + 'ValidTotalBridgeTime' => ['description' => 'The total duration of valid calls.', 'type' => 'string', 'example' => '00:00:42', 'title' => ''], + 'MaxBridgeTime' => ['description' => 'The maximum call duration.', 'type' => 'string', 'example' => '00:00:45', 'title' => ''], + 'Clid' => ['description' => 'The caller ID number.', 'type' => 'string', 'example' => '01089192349', 'title' => ''], + 'TrunkGroupKey' => ['description' => 'The trunk group key.', 'type' => 'string', 'example' => '10000', 'title' => ''], + 'CallType' => ['description' => 'The call type.', 'type' => 'string', 'example' => '示例值', 'title' => ''], + 'PreviewObCustomerRingingCount' => ['description' => 'The number of times the call rang.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], + 'AvgPreviewObWaitTime' => ['description' => 'The average wait time.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'PreviewObCustomerRingingRate' => ['description' => 'The call ringing rate.', 'type' => 'string', 'example' => '95%', 'title' => ''], + 'ValidAvgBridgeTime' => ['description' => 'The average duration of valid calls.', 'type' => 'string', 'example' => '00:00:21', 'title' => ''], + 'AnsweredCount' => ['description' => 'The number of answered calls.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + 'AvgBridgeTime' => ['description' => 'The average call duration.', 'type' => 'string', 'example' => '00:02:12', 'title' => ''], + 'ValidCalls' => ['description' => 'The number of valid calls.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'DateTimeRange' => ['description' => 'The reporting time range.', 'type' => 'string', 'example' => '2026年4月', 'title' => ''], + 'Hour' => ['description' => 'The hour of the day, in 24-hour format (0-23).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the record.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'City' => ['description' => 'The city.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'Province' => ['description' => 'The province.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of outbound calls.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'TotalBridgeTime' => ['description' => 'The total call duration.', 'type' => 'string', 'example' => '00:08:48', 'title' => ''], + 'Day' => ['description' => 'The report date.', 'type' => 'string', 'example' => '2026-04-20', 'title' => ''], + 'CustomerBillMinute' => ['description' => 'The customer\'s billable minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '45', 'title' => ''], + 'MinBridgeTime' => ['description' => 'The minimum call duration.', 'type' => 'string', 'example' => '00:00:03', 'title' => ''], + 'RowName' => ['description' => 'The name of the data row.', 'type' => 'string', 'example' => '外显号码[01089192349]', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The response status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudOutboundObClidReport', + 'summary' => 'Gets caller report data for preview outbound calls.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ClidRate\\": \\"20%\\",\\n \\"ValidTotalBridgeTime\\": \\"00:00:42\\",\\n \\"MaxBridgeTime\\": \\"00:00:45\\",\\n \\"Clid\\": \\"01089192349\\",\\n \\"TrunkGroupKey\\": \\"10000\\",\\n \\"CallType\\": \\"示例值\\",\\n \\"PreviewObCustomerRingingCount\\": 19,\\n \\"AvgPreviewObWaitTime\\": 5,\\n \\"PreviewObCustomerRingingRate\\": \\"95%\\",\\n \\"ValidAvgBridgeTime\\": \\"00:00:21\\",\\n \\"AnsweredCount\\": \\"4\\",\\n \\"EnterpriseId\\": 7000002,\\n \\"AvgBridgeTime\\": \\"00:02:12\\",\\n \\"ValidCalls\\": \\"2\\",\\n \\"DateTimeRange\\": \\"2026年4月\\",\\n \\"Hour\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\",\\n \\"TotalCount\\": \\"20\\",\\n \\"TotalBridgeTime\\": \\"00:08:48\\",\\n \\"Day\\": \\"2026-04-20\\",\\n \\"CustomerBillMinute\\": 45,\\n \\"MinBridgeTime\\": \\"00:00:03\\",\\n \\"RowName\\": \\"外显号码[01089192349]\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-hangzhou-internal-prod-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudOutboundPreviewObReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6000001', 'title' => ''], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['description' => 'The time range type for the report. Valid values: 1 (daily report), 2 (weekly report), 3 (monthly report), and 4 (custom time).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StatisticMethod', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method. Valid values: 0 (by hour), 1 (by day), and 2 (summary).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID. You can query preview dialing statistics for one or more agents. To specify multiple agent IDs, separate them with a comma (,). If you leave this parameter empty, the operation returns statistics for all agents in your account.', 'type' => 'string', 'required' => true, 'example' => '3008', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start date in the yyyy-MM-dd format.', 'type' => 'string', 'required' => true, 'example' => '2017-06-13', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end date in the yyyy-MM-dd format.', 'type' => 'string', 'required' => true, 'example' => '2017-06-13', 'title' => ''], + ], + [ + 'name' => 'StartHour', + 'in' => 'query', + 'schema' => ['description' => 'The start hour of the time range. Valid values: 0 to 23. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'EndHour', + 'in' => 'query', + 'schema' => ['description' => 'The end hour of the time range. Valid values: 0 to 23. The default value is 24.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The pagination offset. The value must be 0 or greater. The default is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 1,000. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records on each page.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ValidTotalBridgeTime' => ['description' => 'The total duration of valid calls.', 'type' => 'string', 'example' => '00:00:38', 'title' => ''], + 'MaxBridgeTime' => ['description' => 'The maximum talk time.', 'type' => 'string', 'example' => '00:00:14', 'title' => ''], + 'AxbObTotalCount' => ['description' => 'The total number of outbound AXB calls.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '3008', 'title' => ''], + 'AxbBothAnsweredTime' => ['description' => 'The total duration of AXB calls in which both parties answered.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CustomerRate' => ['description' => 'The customer answer rate.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'LandlineBothAnsweredRate' => ['description' => 'The answer rate for landline calls in which both parties connected. This is calculated by dividing the number of such connected calls by the total number of outbound landline calls.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'CustomerAnsweredCount' => ['description' => 'The number of calls answered by customers.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'ValidAvgBridgeTime' => ['description' => 'The average duration of valid calls.', 'type' => 'string', 'example' => '00:00:12', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '6000001', 'title' => ''], + 'BothAnsweredTime' => ['description' => 'The total duration of calls answered by both parties.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ValidCalls' => ['description' => 'The number of valid calls.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'AvgBridgeTime' => ['description' => 'The average talk time.', 'type' => 'string', 'example' => '00:00:12', 'title' => ''], + 'CallTotalCount' => ['description' => 'The number of initiated calls.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LandlineBothAnsweredTime' => ['description' => 'The total duration of landline calls answered by both parties.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AgentAnsweredCount' => ['description' => 'The number of calls answered by agents.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => 'name3', 'title' => ''], + 'DateTimeRange' => ['description' => 'The time range.', 'type' => 'string', 'example' => '2017年06月13日', 'title' => ''], + 'CallBridgedRate' => ['description' => 'The call answer rate.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'AxbBothAnsweredRate' => ['description' => 'The answer rate for AXB calls in which both parties connected. This is calculated by dividing the number of such connected calls by the total number of outbound AXB calls.', 'type' => 'string', 'example' => '0%', 'title' => ''], + 'LandlineBothAnsweredCount' => ['description' => 'The number of landline calls answered by both parties.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'AgentRate' => ['description' => 'The agent answer rate.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of outbound calls.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'InterceptionCount' => ['description' => 'The number of intercepted calls.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'TotalBridgeTime' => ['description' => 'The total talk time across all calls.', 'type' => 'string', 'example' => '00:00:38', 'title' => ''], + 'AxbBothAnsweredCount' => ['description' => 'The number of AXB calls answered by both parties.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'InterceptionRate' => ['description' => 'The interception rate.', 'type' => 'string', 'example' => '0%', 'title' => ''], + 'VadRate' => ['description' => 'The Voice Activity Detection (VAD) rate, which measures the percentage of time that human speech is detected during a call.', 'type' => 'string', 'example' => '0%', 'title' => ''], + 'LandlineObTotalCount' => ['description' => 'The total number of outbound landline calls.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'BothAnsweredCount' => ['description' => 'The number of calls answered by both parties.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'MinBridgeTime' => ['description' => 'The minimum talk time.', 'type' => 'string', 'example' => '00:00:11', 'title' => ''], + ], + 'description' => 'An object that contains the report data.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'A list of objects, each containing the report data.', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => 'The response.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudOutboundPreviewObReport', + 'summary' => 'Retrieve the preview outbound call report.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalPageCount\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"List\\": [\\n {\\n \\"ValidTotalBridgeTime\\": \\"00:00:38\\",\\n \\"MaxBridgeTime\\": \\"00:00:14\\",\\n \\"AxbObTotalCount\\": \\"0\\",\\n \\"Cno\\": \\"3008\\",\\n \\"AxbBothAnsweredTime\\": \\"0\\",\\n \\"CustomerRate\\": \\"100%\\",\\n \\"LandlineBothAnsweredRate\\": \\"100%\\",\\n \\"CustomerAnsweredCount\\": \\"3\\",\\n \\"ValidAvgBridgeTime\\": \\"00:00:12\\",\\n \\"EnterpriseId\\": \\"6000001\\",\\n \\"BothAnsweredTime\\": \\"2\\",\\n \\"ValidCalls\\": \\"3\\",\\n \\"AvgBridgeTime\\": \\"00:00:12\\",\\n \\"CallTotalCount\\": \\"3\\",\\n \\"LandlineBothAnsweredTime\\": \\"0\\",\\n \\"AgentAnsweredCount\\": \\"3\\",\\n \\"AgentName\\": \\"name3\\",\\n \\"DateTimeRange\\": \\"2017年06月13日\\",\\n \\"CallBridgedRate\\": \\"100%\\",\\n \\"AxbBothAnsweredRate\\": \\"0%\\",\\n \\"LandlineBothAnsweredCount\\": \\"3\\",\\n \\"AgentRate\\": \\"100%\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"InterceptionCount\\": \\"0\\",\\n \\"TotalBridgeTime\\": \\"00:00:38\\",\\n \\"AxbBothAnsweredCount\\": \\"0\\",\\n \\"InterceptionRate\\": \\"0%\\",\\n \\"VadRate\\": \\"0%\\",\\n \\"LandlineObTotalCount\\": \\"0\\",\\n \\"BothAnsweredCount\\": \\"3\\",\\n \\"MinBridgeTime\\": \\"00:00:11\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-hangzhou-internal-test-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudPauseTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the outbound call task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'PauseDuration', + 'in' => 'query', + 'schema' => ['description' => 'The pause duration. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'A deprecated parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudPauseTask', + 'summary' => 'Pauses a call task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-hangzhou-internal-test-2', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-3', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-test-306', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong-finance-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudPreviewoutcall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID. The ID must be a 3- to 10-digit number.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'Tel', + 'in' => 'query', + 'schema' => ['description' => 'The customer\'s phone number. For landlines, include the area code. For mobile numbers, do not include a leading 0. If number masking is enabled, use the `customerNumberKey` value from the screen pop to place the call. For an [encrypted outbound call](../%E5%AD%97%E6%AE%B5%E5%AE%9A%E4%B9%89/%E6%8E%A5%E5%8F%A3%E9%83%A8%E5%88%86/%E5%8A%A0%E5%AF%86%E5%A4%96%E5%91%BC%E5%8F%B7%E7%A0%81%E5%8A%A0%E5%AF%86%E8%A7%84%E5%88%99.md), the number, if encrypted, must be URL-encoded. If your account is configured to support outbound calls with an extension, you can use the `PhoneNumber-Extension` format.', 'type' => 'string', 'required' => true, 'example' => '1774821736', 'title' => ''], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period for calling the agent, in seconds. The value must be between 5 and 60, inclusive. The default value is 30.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16', 'title' => ''], + ], + [ + 'name' => 'DialTelTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period for calling the customer, in seconds. The value must be between 5 and 60, inclusive. The default value is 45.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '26', 'title' => ''], + ], + [ + 'name' => 'CallVariables', + 'in' => 'query', + 'schema' => ['description' => 'A JSON string that specifies channel variables. You can use channel variables to:
1. Populate fields in event notifications.
2. Store as custom fields in call records.
3. Pass to downstream services through SIP headers.
Format: `[{"name":"variable_name","value":"variable_value","type":"variable_type"}]`



', 'type' => 'string', 'required' => false, 'example' => '[{"name":"mainUniqueId","value":"cdr_main_unique_id","type":"2"},{"name":"callType","value":"cdr_call_type","type":"2"}]', 'title' => ''], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'A unique request ID. If you do not specify this parameter, the system generates one. If the value is encrypted, it must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => 'req1234567', 'title' => ''], + ], + [ + 'name' => 'BackupTels', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of up to five backup phone numbers. If the call to the primary number (specified in the `Tel` parameter) fails, the system calls these numbers.', 'type' => 'string', 'required' => false, 'example' => '41008502', 'title' => ''], + ], + [ + 'name' => 'IsInvestigation', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to conduct a satisfaction survey. If you omit this parameter, the system uses the enterprise-level setting.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'CdrIsAsr', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform ASR transcription for the call recording. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'CrnId', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID navigation identifier.', 'type' => 'string', 'required' => false, 'example' => '12333', 'title' => ''], + ], + [ + 'name' => 'ObClid', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID to display to the called party. You can specify an enterprise trunk number or a pre-configured customer-side caller ID.', 'type' => 'string', 'required' => false, 'example' => '41008502', 'title' => ''], + ], + [ + 'name' => 'ObClidAreaCode', + 'in' => 'query', + 'schema' => ['description' => 'The area code for the caller ID. The system selects a number within this area code to display as the caller ID. If both `ObClid` and `ObClidAreaCode` are specified, `ObClid` takes precedence.', 'type' => 'string', 'required' => false, 'example' => '010', 'title' => ''], + ], + [ + 'name' => 'ObClidGroup', + 'in' => 'query', + 'schema' => ['description' => 'The customer-side caller ID group. To use this parameter, your account must support routing by identifier. If this parameter is specified, the `ObClid` parameter is ignored.', 'type' => 'string', 'required' => false, 'example' => '333', 'title' => ''], + ], + [ + 'name' => 'ClidList', + 'in' => 'query', + 'schema' => ['description' => 'A list of caller IDs in a JSON string. Example: `[{"clid":"1708587xxxx","priority":1},{"clid":"1304412xxxx","priority":2},{"clid":"0107990xxxx","priority":3}]`'."\n" + ."\n" + .'You can specify a maximum of 10 caller IDs for a single call. If you specify for one number, you must specify it for all numbers in the list.', 'type' => 'string', 'required' => false, 'example' => ' [{"clid":"1708587xxxx","priority":1},{"clid":"1304412xxxx","priority":2},{"clid":"0107990xxxx","priority":3}]', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details on the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- `OK` indicates the request was successful.'."\n" + ."\n" + .'- For a list of other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudPreviewoutcall', + 'summary' => 'Places an outbound call when an agent is online.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudQueryAgent' => [ + 'summary' => 'Lists agent details.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the queue. If a queue ID is provided, the operation returns all agent records in that queue.', 'type' => 'string', 'required' => false, 'example' => '333', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'A list of agent IDs, separated by commas. You can specify up to 500 agent IDs.', 'type' => 'string', 'required' => false, 'example' => '1111,2222', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The starting position for the query. The value must be an integer greater than or equal to `0`. Default value: `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return. Valid values: `1` to `1,000`. Default value: `10`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the agent is enabled. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the agent is online. Valid values: `0` (offline) and `1` (online).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order by creation time. Valid values: `0` (ascending order) and `1` (descending order).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'WebrtcUrlType', + 'in' => 'query', + 'schema' => ['description' => 'The type of address to return for the WebRTC softphone. Valid values: `0` (enterprise default), `1` (public domain name), `2` (private domain name), `3` (public IP), and `4` (private IP).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the creation time range to query. The time must be in the `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the creation time range to query. The time must be in the `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 12:00:00', 'title' => ''], + ], + [ + 'name' => 'ReturnQueue', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return information about the agent\'s bound queues. Valid values: `1` (returns queue information) and `0` (does not return queue information). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The agent name to use as a filter. This parameter supports fuzzy matching by prefix and suffix.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The agent comments to use as a filter. This parameter supports fuzzy matching by prefix.', 'type' => 'string', 'required' => false, 'example' => 'comment1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'Agents' => [ + 'description' => 'The list of agents.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Agent' => [ + 'description' => 'The agent\'s details.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the agent. Valid values: `0` (Offline) and `1` (Online).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IsQualityCheck' => ['description' => 'Specifies whether the quality check feature is enabled for the agent. Valid values: `0` (Disabled) and `1` (Enabled). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CallPower' => ['description' => 'The calling permissions. Valid values: `0` (Unlimited), `1` (National long-distance), `2` (Local), and `3` (Internal). The default value is `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ObClid' => ['description' => 'The outbound caller ID.', 'type' => 'string', 'example' => '41008502', 'title' => ''], + 'Cno' => ['description' => 'The ID of the agent.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the agent was created, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'IbRecord' => ['description' => 'Specifies whether inbound calls are recorded. Valid values: `0` (Disabled) and `1` (Enabled). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'BindTelType' => ['description' => 'The type of phone bound to the agent. Valid values: `1` (Landline), `2` (Mobile phone), `3` (Extension), and `4` (softphone).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Wrapup' => ['description' => 'The wrap-up time, in seconds. The default value is `10`.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ObRecord' => ['description' => 'Specifies whether outbound calls are recorded. Valid values: `0` (Disabled) and `1` (Enabled). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The ID of the enterprise.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The name of the agent.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'IsAsr' => ['description' => 'Specifies whether Automatic Speech Recognition (ASR) transcription is enabled. Valid values: `0` (Disabled) and `1` (Enabled). The default value is `0`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AgentType' => ['description' => 'The type of the agent. Valid values: `1` (Phone-based) and `2` (PC-based). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Active' => ['description' => 'Specifies whether the agent is enabled. Valid values: `0` (Disabled) and `1` (Enabled). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObClidType' => ['description' => 'The display rule for the outbound caller ID. Valid values: `1` (Enterprise default), `2` (Random), `3` (By area code), and `4` (Dynamic).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'WebrtcUrlType' => ['description' => 'The type of URL for the WebRTC softphone. Valid values: `0` (Enterprise default), `1` (Public domain name), `2` (Private domain name), `3` (Public IP address), and `4` (Private IP address).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'BindTel' => ['description' => 'The phone number bound to the agent.', 'type' => 'string', 'example' => '41008502', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the agent.', 'type' => 'string', 'example' => '133', 'title' => ''], + 'Power' => ['description' => 'The role of the agent. Valid values: `1` (supervisor) and `0` (regular agent). The default value is `0`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IsOb' => ['description' => 'Specifies whether the agent is allowed to make outbound calls. Valid values: `0` (Not allowed) and `1` (Allowed). The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'QueueList' => [ + 'description' => 'The agent\'s assigned queues.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['description' => 'The service level threshold, in seconds. Calls answered within this time meet the service level objective.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'AnnounceSound' => ['description' => 'Specifies whether to play a fixed audio announcement. Valid values: `0` (Off) and `1` (On).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'WrapupTime' => ['description' => 'The wrap-up time, in seconds. Valid values: 3 to 3600.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'MaxLen' => ['description' => 'The maximum number of callers allowed in the queue. Valid values: 0 to 999. A value of `0` indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'queue_name', 'title' => ''], + 'AnnouncePosition' => ['description' => 'Specifies the condition for announcing the caller\'s position in the queue. Valid values: `0` (Off), `1` (Announce when the position is greater than the value of `AnnouncePositionParam`), or `2` (Announce when the position is less than or equal to the value of `AnnouncePositionParam`).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AnnounceSoundFile' => ['description' => 'The audio file for the fixed announcement.', 'type' => 'string', 'example' => 'voice_filexxxxx', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the queue was created, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'QueueTimeout' => ['description' => 'The maximum wait time for a caller in the queue, in seconds. Valid values: 5 to 600. The default value is 600.', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''], + 'AnnounceSoundFrequency' => ['description' => 'The playback interval for the fixed audio announcement, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '17', 'title' => ''], + 'AnnouncePositionYouarenext' => ['description' => 'Specifies whether to play the "You are next in line" announcement. Valid values: `0` (Off) and `1` (On).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AnnouncePositionParam' => ['description' => 'The position threshold for the `AnnouncePosition` setting. The value must be an integer greater than or equal to `2`.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'MemberTimeout' => ['description' => 'The time in seconds that a call rings for an agent before it is routed to the next agent. Valid values: 20 to 60. The default value is 25.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'Weight' => ['description' => 'The priority of the queue. Valid values: 1 to 10. The higher the value, the higher the priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'JoinEmpty' => ['description' => 'Specifies the agent states considered unavailable. A caller cannot join a queue if all agents are in one of the specified states. Valid values: `1` (busy), `2` (in a call), `4` (ringing), `8` (invalid), and `16` (wrap-up).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The ID of the enterprise.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + 'Qno' => ['description' => 'The number of the queue.', 'type' => 'string', 'example' => '322', 'title' => ''], + 'MusicClass' => ['description' => 'The class of the music-on-hold.', 'type' => 'string', 'example' => 'class1', 'title' => ''], + 'Strategy' => ['description' => 'The call routing strategy. Valid values: `rrordered` (skill-based priority), `rrmemory` (round-robin), `fewestcalls` (fewest calls), `random` (random), `linear` (linear), and `leastrecent` (longest idle time).', 'type' => 'string', 'example' => 'rrordered', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '76', 'title' => ''], + 'Retry' => ['description' => 'The delay, in seconds, before the call is routed to the next agent if the current agent does not answer.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'SayAgentno' => ['description' => 'Specifies whether to announce the agent\'s ID. Valid values: `true` (Announce) and `false` (Do not announce).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'VipSupport' => ['description' => 'Specifies whether VIP support is enabled for the queue. Valid values: `1` (Enabled) and `0` (Disabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AnnouncePositionFrequency' => ['description' => 'The announcement interval for the caller\'s position in the queue, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code of the request.'."\n" + ."\n" + .'- A value of `OK` indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [Error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryAgent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Total\\": 30,\\n \\"Agents\\": [\\n {\\n \\"Agent\\": {\\n \\"Status\\": \\"1\\",\\n \\"IsQualityCheck\\": \\"1\\",\\n \\"CallPower\\": \\"0\\",\\n \\"ObClid\\": \\"41008502\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"IbRecord\\": \\"1\\",\\n \\"BindTelType\\": \\"1\\",\\n \\"Wrapup\\": \\"10\\",\\n \\"ObRecord\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name1\\",\\n \\"IsAsr\\": \\"1\\",\\n \\"AgentType\\": \\"1\\",\\n \\"Active\\": \\"1\\",\\n \\"ObClidType\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"0\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"BindTel\\": \\"41008502\\",\\n \\"Id\\": \\"133\\",\\n \\"Power\\": \\"1\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"QueueList\\": [\\n {\\n \\"ServiceLevel\\": 5,\\n \\"AnnounceSound\\": 1,\\n \\"WrapupTime\\": 30,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queue_name\\",\\n \\"AnnouncePosition\\": 1,\\n \\"AnnounceSoundFile\\": \\"voice_filexxxxx\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueTimeout\\": 600,\\n \\"AnnounceSoundFrequency\\": 17,\\n \\"AnnouncePositionYouarenext\\": 1,\\n \\"AnnouncePositionParam\\": 4,\\n \\"MemberTimeout\\": 25,\\n \\"Weight\\": 10,\\n \\"JoinEmpty\\": 1,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"322\\",\\n \\"MusicClass\\": \\"class1\\",\\n \\"Strategy\\": \\"rrordered\\",\\n \\"Id\\": 76,\\n \\"Retry\\": 20,\\n \\"SayAgentno\\": true,\\n \\"VipSupport\\": 1,\\n \\"AnnouncePositionFrequency\\": 10\\n }\\n ]\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-qingdao-nebula', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudQueryAgentCnoAndName' => [ + 'summary' => 'Retrieves agent IDs and names.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of up to 1,000 agent IDs. Example: 2000,20001', 'type' => 'string', 'required' => false, 'example' => '2000,20001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The reason for the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '2000', 'title' => ''], + 'Name' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '李四', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'A list of agent IDs and agent names.', + 'title' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- `OK` indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [Error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryAgentCnoAndName', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Cno\\": \\"2000\\",\\n \\"Name\\": \\"李四\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudQueryAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Access denied details.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The outbound group name.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'Comment' => ['description' => 'The description of the outbound group.', 'type' => 'string', 'example' => 'description', 'title' => ''], + 'Type' => ['description' => 'The type of the outbound group. Valid values: `1` (General Outbound Group) and `2` (outbound group).', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the outbound group was created. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'Gno' => ['description' => 'The outbound group number.', 'type' => 'string', 'example' => '233', 'title' => ''], + 'Id' => ['description' => 'The outbound group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryAgentGroup', + 'summary' => 'Queries the outbound group of an agent.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"name1\\",\\n \\"Comment\\": \\"description\\",\\n \\"Type\\": 2,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Gno\\": \\"233\\",\\n \\"Id\\": 33,\\n \\"EnterpriseId\\": 7000002\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - [ - 'regionId' => 'cn-shanghai-et15-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'CloudQueryAgentSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'One or more agent IDs, separated by commas.', 'type' => 'string', 'required' => true, 'example' => '111,222', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The access denial details.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5B0F201F-DCDA-45C2-AA92-1AE177F94991', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'A list of agent skills.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillName' => ['description' => 'The skill name.', 'type' => 'string', 'example' => 'skillname', 'title' => ''], + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'SkillId' => ['description' => 'The skill ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '79', 'title' => ''], + 'Id' => ['description' => 'The unique ID for the agent-skill mapping.', 'type' => 'integer', 'format' => 'int64', 'example' => '99', 'title' => ''], + 'AgentId' => ['description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The container for the response data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- A value of `OK` indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error code](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryAgentSkill', + 'summary' => 'Queries agent skills by their agent IDs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"5B0F201F-DCDA-45C2-AA92-1AE177F94991\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"SkillName\\": \\"skillname\\",\\n \\"SkillLevel\\": 7,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"SkillId\\": 79,\\n \\"Id\\": 99,\\n \\"AgentId\\": 64,\\n \\"EnterpriseId\\": 7000002\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryIbCdr' => [ + 'summary' => 'Use this API to query inbound call records by criteria.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['description' => 'If specified, the system ignores all other filter parameters and queries only the record that matches this unique ID.', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The call result. Valid values:', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['description' => 'The province of the customer\'s phone number. For example, `Sichuan`. If you leave this parameter empty, the system queries records from all provinces. The value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['description' => 'The city of the customer\'s phone number. For example, `Chengdu`. If you leave this parameter empty, the system queries records from all cities. The value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies how the time range defined by `StartTime` and `EndTime` applies to the query. This parameter is used only when both `StartTime` and `EndTime` are specified. Valid values are `1` for call start time and `2` for call end time. Default: `1`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the query time range, specified as a Unix timestamp in seconds. The time range defined by `StartTime` and `EndTime` must be within the same calendar month. Default: The first day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the query time range, specified as a Unix timestamp in seconds. The time range defined by `StartTime` and `EndTime` must be within the same calendar month. Default: The last day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775030413', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The offset for pagination. The value must be `0` or greater. Default: `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of records to return on each page. The value must be an integer from 1 to 1,000. Default: `10`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['description' => 'The key of the custom field to use for filtering. You must also specify `UserFieldValue` if you use this parameter. Queries support only a single custom field. Fuzzy matching is not supported. The query condition is constructed in the format `{"userFieldkey":"userFieldvalue"}`. The value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => 'userFieldkey', 'title' => ''], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of the custom field to use for filtering. You must also specify `UserFieldkey` if you use this parameter. Queries support only a single custom field. Fuzzy matching is not supported. The query condition is constructed in the format `{"userFieldkey":"userFieldvalue"}`. The value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => 'userFieldvalue', 'title' => ''], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['description' => 'The customer\'s phone number.', 'type' => 'string', 'required' => false, 'example' => '17750247753', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID. You can specify multiple agent IDs by separating them with commas (`,`).', 'type' => 'string', 'required' => false, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['description' => 'The queue ID. A value of `-1` indicates that the call did not enter a queue.', 'type' => 'string', 'required' => false, 'example' => '566', 'title' => ''], + ], + [ + 'name' => 'LeaveQueueCode', + 'in' => 'query', + 'schema' => ['description' => 'The reason for leaving the queue. Valid values:', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'JoinQueueCode', + 'in' => 'query', + 'schema' => ['description' => 'The reason for not entering the queue. Valid values:', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'CalleeNumber', + 'in' => 'query', + 'schema' => ['description' => 'The agent number.', 'type' => 'string', 'required' => false, 'example' => '41008502', 'title' => ''], + ], + [ + 'name' => 'Hotline', + 'in' => 'query', + 'schema' => ['description' => 'The hotline number.', 'type' => 'string', 'required' => false, 'example' => '10003221', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'An array of inbound call detail records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NumberTrunk' => ['description' => 'The trunk number.', 'type' => 'string', 'example' => '89193631', 'title' => ''], + 'CustomerProvince' => ['description' => 'The province where the customer\'s number is registered. For example, Beijing.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'EndTime' => ['description' => 'The time when the call ended. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'Cno' => ['description' => 'The agent ID. Example: 2000.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'UserField' => ['description' => 'The custom fields of the call record in the JSON format.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'CallType' => ['description' => 'The call type. The value is Inbound.', 'type' => 'string', 'example' => '呼入', 'title' => ''], + 'AnswerTime' => ['description' => 'The time when the system answered the call. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'StatusCode' => ['description' => 'The status code that corresponds to the `Status` parameter.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'EndReason' => ['description' => 'The reason why the call was terminated after being answered. Valid values: `1000`: The call was terminated by the main channel. `1001`: The call was terminated by a non-main channel. `1002`: The call was forcibly disconnected.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Qno' => ['description' => 'The queue ID. Example: 1000.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'RecordFile' => [ + 'description' => 'An array of call recordings in the JSON format.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['description' => '1. The recording type. Valid values: `1` (mixed-stream recording), `2` (separate-stream recording that saves two mono WAV files), `3` (voicemail), and `5` (separate-stream recording that saves one stereo WAV file).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The file type. Valid values: `record` (recording) and `voicemail` (voicemail).', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'File' => ['description' => 'The recording file name.', 'type' => 'string', 'example' => 'name3', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'CustomerNumber' => ['description' => 'The customer\'s phone number. The value must be a landline number or a mobile number in the Chinese mainland. A landline number is in the area code-local number format. The area code and local number are not separated by a hyphen (-). A mobile number is 11 digits in length. Examples: `01041005968` and `18701051984`.', 'type' => 'string', 'example' => '18701051984', 'title' => ''], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'Hotline' => ['description' => 'The hotline number.', 'type' => 'string', 'example' => '89193631', 'title' => ''], + 'IvrName' => ['description' => 'The IVR name. The default value is `custom`.', 'type' => 'string', 'example' => 'ivrname', 'title' => ''], + 'Status' => ['description' => 'The call result. Example: Answered by Agent.', 'type' => 'string', 'example' => '人工接听', 'title' => ''], + 'UniqueId' => ['description' => 'The unique ID of the call.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'NumberTrunkAreaCode' => ['description' => 'The area code of the trunk number.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'CustomerCity' => ['description' => 'The city where the customer\'s number is registered. Example: Beijing.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'StartTime' => ['description' => 'The time when the call entered the system. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'CustomerAreaCode' => ['description' => 'The area code of the customer\'s number.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'CalleeNumber' => ['description' => 'The agent\'s phone number. The value can be a landline number or an 11-digit mobile number. A landline number is in the area code-local number format. The area code and local number are not separated by a hyphen (-). Example: `0104100596`.', 'type' => 'string', 'example' => '0104100596', 'title' => ''], + 'TotalDuration' => ['description' => 'The total call duration. Unit: seconds.', 'type' => 'string', 'example' => '133', 'title' => ''], + 'BridgeDuration' => ['description' => 'The service processing duration. Unit: seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'BridgeTime' => ['description' => 'The time when the agent answered the call. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'LeaveQueueCode' => ['description' => 'The reason why the user left the queue. Valid values: -1: No value is available. 1: The call was transferred to an agent and answered. 2: The call was abandoned in the queue. 3: The call timed out in the queue. 4: The call overflowed because no agent was available.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryIbCdr', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"NumberTrunk\\": \\"89193631\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"EndTime\\": \\"1775024775\\",\\n \\"Cno\\": \\"1111\\",\\n \\"UserField\\": {},\\n \\"CallType\\": \\"呼入\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"StatusCode\\": \\"3\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"1000\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\"name3\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"18701051984\\",\\n \\"AgentName\\": \\"name1\\",\\n \\"Hotline\\": \\"89193631\\",\\n \\"IvrName\\": \\"ivrname\\",\\n \\"Status\\": \\"人工接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"NumberTrunkAreaCode\\": \\"010\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"StartTime\\": \\"1775024775\\",\\n \\"CustomerAreaCode\\": \\"010\\",\\n \\"CalleeNumber\\": \\"0104100596\\",\\n \\"TotalDuration\\": \\"133\\",\\n \\"BridgeDuration\\": \\"10\\",\\n \\"BridgeTime\\": \\"1775024775\\",\\n \\"LeaveQueueCode\\": -1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryObCdr' => [ + 'summary' => 'Searches for agent outbound call records by criteria.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the call. If you specify this parameter, the API ignores all other parameters and returns only the record with the matching unique ID.', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The request unique ID. The system queries the current month by default. If the record for the specified `RequestUniqueId` is not in the current month, you must also specify the `StartTime` parameter.', 'type' => 'string', 'required' => false, 'example' => 'req_uniq_1-162046xxxx.12', 'title' => ''], + ], + [ + 'name' => 'CallType', + 'in' => 'query', + 'schema' => ['description' => 'The call type. If omitted, all call types are returned. Valid values: `4` (Preview outbound call), `6` (Caller-initiated outbound call), and `9` (Internal call).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The call result. Valid values: `30` (Agent did not answer), `31` (Agent answered, customer not dialed), `32` (Agent answered, customer did not answer), `33` (Both agent and customer answered), `50` (Caller-initiated outbound call: customer answered), `51` (Caller-initiated outbound call: customer did not answer), `52` (Caller-initiated outbound call: both parties answered).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '33 ', 'title' => ''], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['description' => 'The province where the customer\'s phone number is registered. If omitted, records from all provinces are returned. Example: `Sichuan`. This value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['description' => 'The city where the customer\'s phone number is registered. If omitted, records from all cities are returned. Example: `Chengdu`. This value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies which timestamp the `StartTime` and `EndTime` parameters apply to. This parameter applies only when you specify both `StartTime` and `EndTime`. Valid values: `1` (start time) and `2` (end time). Default: `1`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query time range, specified as a Unix timestamp in seconds. The `StartTime` and `EndTime` must be within the same calendar month. Default: The first day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query time range, specified as a Unix timestamp in seconds. The `StartTime` and `EndTime` must be within the same calendar month. Default: The last day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775030413', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The zero-based index of the first record to return. Default: `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records to return per page. The value must be in the range of 1 to 1,000. Default: `10`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['description' => 'The key of a user-defined field. Use this parameter with `UserFieldValue` to filter results by a specific user-defined field. Fuzzy matching is not supported. This value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '{"userFieldkey":"userFieldvalue"}', 'title' => ''], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of a user-defined field. Use this parameter with `UserFieldkey` to filter results by a specific user-defined field. Fuzzy matching is not supported. This value must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '{"userFieldkey":"userFieldvalue"}', 'title' => ''], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['description' => 'The customer number. To query multiple numbers, provide a comma-separated list of up to 100 numbers. Fuzzy matching is not supported.', 'type' => 'string', 'required' => false, 'example' => '13322223333', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID. Each ID must be 3 to 10 characters long. To query multiple IDs, provide a comma-separated list of up to 100 IDs. Fuzzy matching is not supported.', 'type' => 'string', 'required' => false, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s outbound group ID. The ID must be 2 to 20 characters long. To query multiple IDs, provide a comma-separated list of up to 10 IDs. Fuzzy matching is not supported.', 'type' => 'string', 'required' => false, 'example' => '455', 'title' => ''], + ], + [ + 'name' => 'AgentNumber', + 'in' => 'query', + 'schema' => ['description' => 'The agent number.', 'type' => 'string', 'required' => false, 'example' => '41008502', 'title' => ''], + ], + [ + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['description' => 'The agent name.', 'type' => 'string', 'required' => false, 'example' => 'name3', 'title' => ''], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['description' => 'The Calling Line Identification (CLID) that was displayed to the customer.', 'type' => 'string', 'required' => false, 'example' => '4100', 'title' => ''], + ], + [ + 'name' => 'LeftDisplayNumber', + 'in' => 'query', + 'schema' => ['description' => 'The actual display number on the customer\'s device. For AXB outbound calls that use a virtual number, this parameter filters by the virtual number if this option is enabled.', 'type' => 'string', 'required' => false, 'example' => '2000', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values: `0` (start time, ascending), `1` (start time, descending), `2` (end time, ascending), `3` (end time, descending).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ReturnCount', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return the total count of matching records. Valid values: `1` (Yes) and `0` (No). Default: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DownGrade', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the call was a downgraded call. Valid values: `0` (No) and `1` (Yes).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IsRealAnswer', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the call was a live answer. Valid values: `0` (No) and `1` (Yes).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The details of the failed request.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'A list of call records for agent outbound calls.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RealAnswerTime' => ['description' => 'The time, as a Unix timestamp in seconds, when a person answered the call. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'CustomerProvince' => ['description' => 'The province associated with the customer\'s number. For example, Beijing.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'DisplayNumber' => ['description' => 'The number displayed to the agent. In an AXB outbound call, this is the virtual number.', 'type' => 'string', 'example' => '41008502', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the automated agent outbound call task.', 'type' => 'string', 'example' => '333', 'title' => ''], + 'EndTime' => ['description' => 'The time, as a Unix timestamp in seconds, when the call ended. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024875', 'title' => ''], + 'Clid' => ['description' => 'The number displayed to the customer. If a virtual number is used for an AXB outbound call and the feature is enabled, this parameter returns the virtual number.', 'type' => 'string', 'example' => '41008502', 'title' => ''], + 'Cno' => ['description' => 'The agent ID. Example: `2000`.', 'type' => 'string', 'example' => '2000'."\n", 'title' => ''], + 'TrunkGroupKey' => ['description' => 'The key of the trunk group.', 'type' => 'string', 'example' => '30020', 'title' => ''], + 'TsiFileFormat' => ['description' => 'The file format of the ring-back tone.', 'type' => 'string', 'example' => 'mp3', 'title' => ''], + 'UserField' => ['description' => 'Custom fields for the call record, in JSON format.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'CallType' => ['description' => 'The type of call. `4` indicates a Preview outbound call and `6` indicates a Caller outbound call.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Gno' => ['description' => 'The agent\'s outbound call group number.', 'type' => 'string', 'example' => '133', 'title' => ''], + 'AnswerTime' => ['description' => 'The time, as a Unix timestamp in seconds, when the agent answered the call. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'RequestUniqueId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'StatusCode' => ['description' => 'The status code of the call.', 'type' => 'string', 'example' => '33', 'title' => ''], + 'WaitDuration' => ['description' => 'The customer\'s wait time in seconds.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'AgentClid' => ['description' => 'The number displayed to the agent.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'HangupReason' => ['description' => 'The reason for the hang-up.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'EndReason' => ['description' => 'The reason an answered call was terminated. Valid values include: `1000` (Primary party disconnected), `1001` (Non-primary party disconnected), and `1002` (Forcibly disconnected).', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'VadOut' => ['description' => 'The percentage of talk time in the outbound direction, which indicates the call quality. The value ranges from 0 to 100.', 'type' => 'string', 'example' => '70', 'title' => ''], + 'RecordFile' => [ + 'description' => 'A list of call recordings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['description' => '1. Audio mixing 2. Multi-track recording (saves two mono WAV files) 3. Voicemail 5. Multi-track recording (saves one stereo WAV file)', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The file type. `record` indicates a recording and `voicemail` indicates a voicemail.', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'File' => ['description' => 'The name of the recording file.', 'type' => 'string', 'example' => 'record_file_name.', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'CustomerNumber' => ['description' => 'The customer\'s phone number. This can be a domestic landline or mobile number. A landline number consists of an area code and a 7- or 8-digit number, with no hyphen in between. A mobile number is 11 digits long. When using a virtual number with an extension, the format is `{virtual_number}-{extension}`. Examples: `01041005968` or `18701051984` or `18701051984-7538`.', 'type' => 'string', 'example' => '01041005968', 'title' => ''], + 'RtcTotalDuration' => ['description' => 'The total duration of the RTC call, in seconds. This parameter applies only to Caller Outbound Calls. The duration is `endTime - startTime`.', 'type' => 'string', 'example' => '133', 'title' => ''], + 'VadIn' => ['description' => 'The percentage of talk time in the inbound direction, which indicates the call quality. The value ranges from 0 to 100.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'CalleeRingingTime' => ['description' => 'The time, as a Unix timestamp in seconds, when the customer\'s phone started ringing. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'AgentName' => ['description' => 'The agent\'s name.', 'type' => 'string', 'example' => 'name3', 'title' => ''], + 'DownGrade' => ['description' => 'Whether the call was downgraded. Valid values: `0` (No) and `1` (Yes).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The result of the outbound call. Valid values: `30` (Agent did not answer), `31` (Agent answered, customer not called), `32` (Agent answered, customer did not answer), `33` (Both parties answered), `50` (Caller outbound call answered), `51` (Caller outbound call, customer did not answer), `52` (Caller outbound call, both parties answered).', 'type' => 'string', 'example' => '33', 'title' => ''], + 'UniqueId' => ['description' => 'The unique ID of the call.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'AgentNumber' => ['description' => 'The agent\'s phone number. This can be a landline number (area code and a 7- or 8-digit number, with no hyphen in between) or an 11-digit mobile number. Example: `0104100596`.', 'type' => 'string', 'example' => '0104100596', 'title' => ''], + 'SipCause' => ['description' => 'The SIP response code, which ranges from 200 to 699. **Note**: For Caller Outbound Calls (RTC), the agent does not initiate the call or perform SIP negotiation, so this value defaults to `0`.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'XNumber' => ['description' => 'The virtual number.', 'type' => 'string', 'example' => '13322444', 'title' => ''], + 'CustomerCity' => ['description' => 'The city associated with the customer\'s number. For example, Beijing.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'StatusReason' => ['description' => 'The reason for the call status. This applies to caller outbound calls. Valid values: `1` (Enterprise blocklist), `2` (Blocked by risk control), `20001` (Call restriction), `20002` (The number is on a blocklist or is not on an allow list), `20003` (Outside allowed calling hours), `3` (Invalid display number), `4` (Incorrect voice navigation), `5` (Enterprise service suspended), `6` (No permission for outbound calls), `7` (Exceeded call limit), `8` (Invalid number), `9` (Other error).', 'type' => 'string', 'example' => '9', 'title' => ''], + 'CallId' => ['description' => 'The unique ID of the call.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'StartTime' => ['description' => 'The time, as a Unix timestamp in seconds, when the agent initiated the outbound call. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'CustomerAreaCode' => ['description' => 'The area code of the customer\'s number.', 'type' => 'string', 'example' => '028', 'title' => ''], + 'IsRealAnswer' => ['description' => 'Whether the call was answered by a person. Valid values: `1` (Yes), `0` (No), or null.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'LeftDisplayNumber' => ['description' => 'The number displayed to the customer. In an AXB outbound call, this is the virtual number.', 'type' => 'string', 'example' => '13322225555', 'title' => ''], + 'DownGradeCounts' => ['description' => 'The number of downgrades.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TotalDuration' => ['description' => 'The total duration of the call, in seconds.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'MainRingingTime' => ['description' => 'For an outbound call from an extension, this is the Unix timestamp (in seconds) when the phone started ringing.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'TsiFile' => ['description' => 'The name of the ring-back tone file.', 'type' => 'string', 'example' => 'name2', 'title' => ''], + 'BridgeDuration' => ['description' => 'The duration, in seconds, that both parties were connected.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'BridgeTime' => ['description' => 'The time, as a Unix timestamp in seconds, when both parties were connected. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'Id' => ['description' => 'The ID.', 'type' => 'string', 'example' => '9075217226', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryObCdr', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"RealAnswerTime\\": \\"1775024775\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"DisplayNumber\\": \\"41008502\\",\\n \\"TaskId\\": \\"333\\",\\n \\"EndTime\\": \\"1775024875\\",\\n \\"Clid\\": \\"41008502\\",\\n \\"Cno\\": \\"2000\\\\n\\",\\n \\"TrunkGroupKey\\": \\"30020\\",\\n \\"TsiFileFormat\\": \\"mp3\\",\\n \\"UserField\\": {},\\n \\"CallType\\": \\"4\\",\\n \\"Gno\\": \\"133\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"RequestUniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"StatusCode\\": \\"33\\",\\n \\"WaitDuration\\": \\"5\\",\\n \\"AgentClid\\": \\"02138276106\\",\\n \\"HangupReason\\": \\"0\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"VadOut\\": \\"70\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\"record_file_name.\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"01041005968\\",\\n \\"RtcTotalDuration\\": \\"133\\",\\n \\"VadIn\\": \\"30\\",\\n \\"CalleeRingingTime\\": \\"1775024775\\",\\n \\"AgentName\\": \\"name3\\",\\n \\"DownGrade\\": \\"1\\",\\n \\"Status\\": \\"33\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"AgentNumber\\": \\"0104100596\\",\\n \\"SipCause\\": \\"200\\",\\n \\"XNumber\\": \\"13322444\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"StatusReason\\": \\"9\\",\\n \\"CallId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"StartTime\\": \\"1775024775\\",\\n \\"CustomerAreaCode\\": \\"028\\",\\n \\"IsRealAnswer\\": \\"1\\",\\n \\"LeftDisplayNumber\\": \\"13322225555\\",\\n \\"DownGradeCounts\\": \\"1\\",\\n \\"TotalDuration\\": \\"30\\",\\n \\"MainRingingTime\\": \\"1775024775\\",\\n \\"TsiFile\\": \\"name2\\",\\n \\"BridgeDuration\\": \\"10\\",\\n \\"BridgeTime\\": \\"1775024775\\",\\n \\"Id\\": \\"9075217226\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryPredictiveCallCdr' => [ + 'summary' => 'Use this API to retrieve predictive outbound call records.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The outbound task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '31111', 'title' => ''], + ], + [ + 'name' => 'TaskFileId', + 'in' => 'query', + 'schema' => ['description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '133', 'title' => ''], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['description' => 'If this parameter is specified, other filter parameters are ignored and only the record associated with this unique call ID is queried.', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique request ID. By default, the system queries records for the current month. If the record associated with this ID is not from the current month, you must also specify the `StartTime` parameter.', 'type' => 'string', 'required' => false, 'example' => 'req-uniq_1-162046xxxx.12', 'title' => ''], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['description' => 'The customer\'s phone number. Example: `18012345678`.', 'type' => 'string', 'required' => false, 'example' => '18012345678', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID, which must be a 3- to 10-digit number.', 'type' => 'string', 'required' => false, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s outbound group ID. You can specify up to 10 comma-separated IDs, each 2 to 20 characters long. Fuzzy matching is not supported.', 'type' => 'string', 'required' => false, 'example' => 'WH13', 'title' => ''], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID number.', 'type' => 'string', 'required' => false, 'example' => '02138276106', 'title' => ''], + ], + [ + 'name' => 'DisplayNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number displayed to the customer. In number substitution scenarios, such as AXB, this is the virtual number.', 'type' => 'string', 'required' => false, 'example' => '02138276106', 'title' => ''], + ], + [ + 'name' => 'DownGrade', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the call was downgraded. Valid values: `0` (No) and `1` (Yes).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The call result. Valid values: 40 (Predictive call, customer did not answer), 41 (Predictive call, customer answered), 42 (Predictive call, initiated), 43 (Predictive call, both parties answered).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '41', 'title' => ''], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['description' => 'The province associated with the customer\'s number. Leave empty to query all provinces. Example: Sichuan. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['description' => 'The city associated with the customer\'s number. Leave empty to query all cities. Example: Chengdu. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['description' => 'The agent name.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies how the time range defined by `StartTime` and `EndTime` is applied. This parameter takes effect only when `StartTime` and `EndTime` are specified. Valid values: 1 (filters by call start time) and 2 (filters by call end time). Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the query time range, specified as a Unix timestamp in seconds. The query range cannot span a calendar month. Default: the first day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the query time range, specified as a Unix timestamp in seconds. The query range cannot span a calendar month. Default: the last day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The pagination offset. Valid values: ≥ 0. Default: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return. Value range: 1–1000. Default: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['description' => 'The key of the user-defined field to use for filtering. If you specify this parameter, you must also specify `UserFieldValue`. This allows you to query based on a single custom field, and fuzzy matching is not supported. The query condition is constructed as `{"userFieldkey":"userFieldValue"}`. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => 'userFieldkey', 'title' => ''], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of the user-defined field to use for filtering. If you specify this parameter, you must also specify `UserFieldkey`. This allows you to query based on a single custom field, and fuzzy matching is not supported. The query condition is constructed as `{"userFieldkey":"userFieldValue"}`. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => 'userFieldvalue', 'title' => ''], + ], + [ + 'name' => 'IsRealAnswer', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the call was answered by a human. Valid values: 1 (Yes) and 0 (No).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated. Ignore it.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'An array of predictive outbound call records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RealAnswerTime' => ['description' => 'The human answer time, in Unix timestamp format (seconds). Example: `1480904471`.', 'type' => 'string', 'example' => '1774904471', 'title' => ''], + 'NumberTrunk' => ['description' => 'The trunk number.', 'type' => 'string', 'example' => '15322355', 'title' => ''], + 'CustomerProvince' => ['description' => 'The province where the customer\'s number is registered. Example: Beijing.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'DisplayNumber' => ['description' => 'The number displayed to the customer. In scenarios that use number substitution, such as AXB, this is a virtual number.', 'type' => 'string', 'example' => '1775024', 'title' => ''], + 'EndTime' => ['description' => 'The time the call ended, in Unix timestamp format (seconds). Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'Clid' => ['description' => 'The caller ID.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'Cno' => ['description' => 'The agent ID. Example: `2000`.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'TrunkGroupKey' => ['description' => 'The trunk group code.', 'type' => 'string', 'example' => '30019', 'title' => ''], + 'UserField' => ['description' => 'The user-defined fields of the call record, in JSON format.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'CalleeDisplayNumber' => ['description' => 'The number displayed to the called party.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'DetailRingingTime' => ['description' => 'The Unix timestamp (in seconds) indicating when the agent\'s phone started ringing after the call was transferred. A value of `0` means the call was not transferred or the agent\'s phone did not ring. Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'CallType' => ['description' => 'The call type.', 'type' => 'string', 'example' => '预测外呼', 'title' => ''], + 'Gno' => ['description' => 'The outbound group ID of the agent. Example: `2000`.', 'type' => 'string', 'example' => '2000', 'title' => ''], + 'AnswerTime' => ['description' => 'The time the system answered the call, in Unix timestamp format (seconds). Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'StatusCode' => ['description' => 'The status code of the outbound result. This value corresponds to the `Status` field. Valid values: `40` (The customer did not answer), `41` (The customer answered), `42` (The call was initiated), and `43` (Both parties were connected).', 'type' => 'string', 'example' => '41', 'title' => ''], + 'RequestUniqueId' => ['description' => 'A user-defined identifier for the call.', 'type' => 'string', 'example' => '543252344', 'title' => ''], + 'CalleeClid' => ['description' => 'The called party\'s caller ID.', 'type' => 'string', 'example' => '15553333', 'title' => ''], + 'WaitDuration' => ['description' => 'The customer\'s waiting time, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'EndReason' => ['description' => 'The reason the call was disconnected after being answered. Valid values: `1000` (The primary party hung up), `1001` (The secondary party hung up), and `1002` (The call was forcibly disconnected).', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Qno' => ['description' => 'The queue number. Example: `1000`.', 'type' => 'string', 'example' => '1000'."\n" + ."\n", 'title' => ''], + 'VadOut' => ['description' => 'The percentage of time that speech was detected on the outbound audio stream, from 0 to 100. This can be used as a call quality metric.', 'type' => 'string', 'example' => '77', 'title' => ''], + 'RecordFile' => [ + 'description' => 'An array of recording objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['description' => '1. The recording format. Valid values: `1` (mixed-channel), `2` (split-channel, saved as two mono WAV files), `3` (voicemail), and `5` (split-channel, saved as one stereo WAV file).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The file type. Valid values: `record` (recording) and `voicemail`.', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'File' => ['description' => 'The recording file name.', 'type' => 'string', 'example' => 'name3', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'CustomerNumber' => ['description' => 'The customer\'s phone number on the Chinese mainland. Supported formats include: an 11-digit mobile number (for example, `18701051984`), a landline number with an area code but no hyphen (for example, `01041005968`), or a virtual number with an extension (for example, `18701051984-7538`).', 'type' => 'string', 'example' => '18701051984', 'title' => ''], + 'VadIn' => ['description' => 'The percentage of time that speech was detected on the inbound audio stream, from 0 to 100. This can be used as a call quality metric.', 'type' => 'string', 'example' => '23', 'title' => ''], + 'CalleeRingingTime' => ['description' => 'The time the customer\'s phone started ringing, in Unix timestamp format (seconds). Example: `1480904471`.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'AgentName' => ['description' => 'The agent name. Example: `Zhang San 1010`.', 'type' => 'string', 'example' => '张三1010', 'title' => ''], + 'DownGrade' => ['description' => 'Indicates whether the call was downgraded. Valid values: `1` (Yes) and `0` (No).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IvrName' => ['description' => 'The IVR name.', 'type' => 'string', 'example' => 'IvrName', 'title' => ''], + 'Status' => ['description' => 'The outbound result. Example: Customer answered.', 'type' => 'string', 'example' => '客户接听', 'title' => ''], + 'UniqueId' => ['description' => 'The unique call identifier.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'SipCause' => ['description' => 'The SIP cause code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'XNumber' => ['description' => 'The virtual number.', 'type' => 'string', 'example' => '6677333', 'title' => ''], + 'CustomerCity' => ['description' => 'The city where the customer\'s number is registered. Example: Beijing.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'CallId' => ['description' => 'The unique call identifier.', 'type' => 'string', 'example' => '3cdf8d08-0216-42df-bba5-0fd45c93c9b3', 'title' => ''], + 'StartTime' => ['description' => 'The time the call entered the system, in Unix timestamp format (seconds). Example: `1480904471`.', 'type' => 'string', 'example' => '1774822300', 'title' => ''], + 'SipCauseStr' => ['description' => 'The string representation of the SIP cause code.', 'type' => 'string', 'example' => '处理成功', 'title' => ''], + 'TaskFileId' => ['description' => 'The task file ID.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'IsRealAnswer' => ['description' => 'Indicates whether the call was answered by a human. Valid values: `1` (Yes), `0` (No), or empty.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DownGradeCounts' => ['description' => 'The number of downgrades.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CalleeNumber' => ['description' => 'The agent number. This can be a landline number in the format of `area code`+`7- or 8-digit number` (with no hyphen), or an 11-digit mobile number. Example: `0104100596`.', 'type' => 'string', 'example' => '0104100596', 'title' => ''], + 'TotalDuration' => ['description' => 'The total call duration, in seconds.', 'type' => 'string', 'example' => '55', 'title' => ''], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'name2', 'title' => ''], + 'BridgeDuration' => ['description' => 'The bridged duration, in seconds.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'Id' => ['description' => 'The primary key of the call record.', 'type' => 'string', 'example' => '123546546', 'title' => ''], + 'BridgeTime' => ['description' => 'The agent answer time, in Unix timestamp format (seconds). Example: `1480904471`.', 'type' => 'string', 'example' => '1774822305', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The data returned by the request.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryPredictiveCallCdr', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"RealAnswerTime\\": \\"1774904471\\",\\n \\"NumberTrunk\\": \\"15322355\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"TaskId\\": \\"1234\\",\\n \\"DisplayNumber\\": \\"1775024\\",\\n \\"EndTime\\": \\"1775024775\\",\\n \\"Clid\\": \\"02138276106\\",\\n \\"Cno\\": \\"1111\\",\\n \\"TrunkGroupKey\\": \\"30019\\",\\n \\"UserField\\": {},\\n \\"CalleeDisplayNumber\\": \\"02138276106\\",\\n \\"DetailRingingTime\\": \\"1775024775\\",\\n \\"CallType\\": \\"预测外呼\\",\\n \\"Gno\\": \\"2000\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"StatusCode\\": \\"41\\",\\n \\"RequestUniqueId\\": \\"543252344\\",\\n \\"CalleeClid\\": \\"15553333\\",\\n \\"WaitDuration\\": \\"10\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"1000\\\\n\\\\n\\",\\n \\"VadOut\\": \\"77\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\"name3\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"18701051984\\",\\n \\"VadIn\\": \\"23\\",\\n \\"CalleeRingingTime\\": \\"1775024775\\",\\n \\"AgentName\\": \\"张三1010\\",\\n \\"DownGrade\\": \\"0\\",\\n \\"IvrName\\": \\"IvrName\\",\\n \\"Status\\": \\"客户接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"SipCause\\": \\"200\\",\\n \\"XNumber\\": \\"6677333\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"CallId\\": \\"3cdf8d08-0216-42df-bba5-0fd45c93c9b3\\",\\n \\"StartTime\\": \\"1774822300\\",\\n \\"SipCauseStr\\": \\"处理成功\\",\\n \\"TaskFileId\\": \\"111\\",\\n \\"IsRealAnswer\\": \\"1\\",\\n \\"DownGradeCounts\\": \\"0\\",\\n \\"CalleeNumber\\": \\"0104100596\\",\\n \\"TotalDuration\\": \\"55\\",\\n \\"TaskName\\": \\"name2\\",\\n \\"BridgeDuration\\": \\"50\\",\\n \\"Id\\": \\"123546546\\",\\n \\"BridgeTime\\": \\"1774822305\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryRasrEvent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique call ID.', 'type' => 'string', 'required' => true, 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'The list of returned data objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UniqueId' => ['description' => 'The unique call ID.', 'type' => 'string', 'example' => 'sip-2-1480660149.0', 'title' => ''], + 'OutRecordFile' => ['description' => 'The name of the bot\'s recording file.', 'type' => 'string', 'example' => 'sip-2-1558615724.87-54529-out', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1768615738', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'RasrDuration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '333', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], + 'Text' => ['description' => 'The transcribed text of the customer\'s dialogue.', 'type' => 'string', 'example' => '[{\\"text\\":\\"示例客户话术\\",\\"beginTime\\":\\"100\\",\\"endTime\\":\\"200\\",\\"sentenceId\\":\\"example\\"}]', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'MainUniqueId' => ['description' => 'The unique ID of the main call.', 'type' => 'string', 'example' => 'sip-2-1558615724.87', 'title' => ''], + 'RecordFile' => ['description' => 'The name of the customer\'s recording file.', 'type' => 'string', 'example' => 'sip-2-1558615724.87-54529-in', 'title' => ''], + 'CustomerNumber' => ['description' => 'The customer\'s phone number.', 'type' => 'string', 'example' => '177xxxx1313', 'title' => ''], + 'MixRecordFile' => ['description' => 'The name of the mixed-stream recording file.', 'type' => 'string', 'example' => 'sip-2-1558615724.87-54529-mix', 'title' => ''], + 'BotText' => ['description' => 'The transcribed text of the bot\'s dialogue.', 'type' => 'string', 'example' => '[{\\"text\\":\\"机器人话术示例\\",\\"beginTime\\":\\"1639471934\\"}]', 'title' => ''], + 'MonitorSide' => ['description' => 'The party that is monitored. Valid values: `1` for the agent (the second party in a web call) and `2` for the customer (the first party in a web call).', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Engine' => ['description' => 'The speech recognition engine.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryRasrEvent', + 'summary' => 'Queries a Real-time Automatic Speech Recognition (RASR) event by using a unique call ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"UniqueId\\": \\"sip-2-1480660149.0\\",\\n \\"OutRecordFile\\": \\"sip-2-1558615724.87-54529-out\\",\\n \\"EndTime\\": 1768615738,\\n \\"Cno\\": \\"1111\\",\\n \\"RasrDuration\\": \\"333\\",\\n \\"StartTime\\": 96,\\n \\"Text\\": \\"[{\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"示例客户话术\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"beginTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"100\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"200\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sentenceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\"}]\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"MainUniqueId\\": \\"sip-2-1558615724.87\\",\\n \\"RecordFile\\": \\"sip-2-1558615724.87-54529-in\\",\\n \\"CustomerNumber\\": \\"177xxxx1313\\",\\n \\"MixRecordFile\\": \\"sip-2-1558615724.87-54529-mix\\",\\n \\"BotText\\": \\"[{\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"机器人话术示例\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"beginTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1639471934\\\\\\\\\\\\\\"}]\\",\\n \\"MonitorSide\\": \\"2\\",\\n \\"Engine\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryTask' => [ + 'summary' => 'Get a list of call tasks that match specific criteria.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The call center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The task type. Valid values: `1` (predictive outbound task) and `2` (automated outbound task).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The task name. The value must be URL-encoded in UTF-8.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The task status. Valid values: `0` (Initial), `1` (Running), `2` (Paused), and `3` (Finished).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'AutoStart', + 'in' => 'query', + 'schema' => ['description' => 'Whether to enable scheduled starts. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'AutoStop', + 'in' => 'query', + 'schema' => ['description' => 'Whether to enable scheduled stops. Valid values: `0` (disabled) and `1` (enabled).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'TimeType', + 'in' => 'query', + 'schema' => ['description' => 'The time filter to apply. Valid values: `1` (task start time), `2` (task end time), and `3` (task creation time).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. The time must be in the `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The time must be in the `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 20:00:00', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The pagination offset. The value must be greater than or equal to 0. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The details about why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TaskProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallVariables' => ['description' => 'The agent channel variables.', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]', 'title' => ''], + 'OverTime' => ['description' => 'The time when the task ended.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'CustomerClidType' => ['description' => 'The rule for displaying the caller ID to the customer. Valid values: `1` (Random) and `2` (By area code).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CustomerVoice' => ['description' => 'The prompt tone played to the customer.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'Cnos' => ['description' => 'The list of agent IDs.', 'type' => 'string', 'example' => '1111,2222', 'title' => ''], + 'Concurrency' => ['description' => 'The maximum concurrency limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'StatusDescription' => ['description' => 'The description of the task status.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'AgentGroup' => ['description' => 'The outbound call group number.', 'type' => 'string', 'example' => 'WH124', 'title' => ''], + 'CustomerClids' => ['description' => 'The list of caller IDs to be displayed to customers.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'AutoComplete' => ['description' => 'Specifies whether to automatically complete the task. Valid values: `0` (Disable) and `1` (Enable).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AutoStart' => ['description' => 'Specifies whether to enable the scheduled start. Valid values: `0` (Disable) and `1` (Enable).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CustomerClidWeightFlag' => ['description' => 'Specifies whether to enable the caller ID ratio configuration. Valid values: `0` (Disable) and `1` (Enable).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Status' => ['description' => 'The task status. Valid values: `0` (Initial), `1` (Running), `2` (Paused), and `3` (Finished).', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'PauseTime' => ['description' => 'The time when the task was paused.', 'type' => 'string', 'example' => '2026-04-20 11:00:00', 'title' => ''], + 'AutoStartDay' => ['description' => 'The date for the scheduled start. The format is `yyyy-MM-dd`. For example, `2017-02-11`.', 'type' => 'string', 'example' => '2017-02-11', 'title' => ''], + 'ClidProperty' => ['description' => 'The caller ID rule in JSON format. This rule determines the caller ID selection, such as the default area code and whether to match the provincial capital. For example, `{"defaultAreaCode":"010", "isMatchCapital":"1"}`.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'RetryStrategyOnlyToday' => ['description' => 'Specifies whether retries are valid only for the current day. Valid values:
`0`: Disable.
`1`: Enable. Deletes both data pending retry and data pending calls.
`2`: Enable. Deletes only data pending retry.
`3`: Enable. Deletes only data pending calls.



', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'WarmUpDuration' => ['description' => 'The task warm-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'PredictAdjust' => ['description' => 'The over-dialing rate.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'StartTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '09:00', 'title' => ''], + 'AutoTaskType' => ['description' => 'The calling mode. Valid values: `0` (Continuous calling) and `1` (Interval calling).', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'AutoStartTime' => ['description' => 'The scheduled start time. The format is `HH:mm:ss`. For example, `08:00:00`.', 'type' => 'string', 'example' => '08:00:00', 'title' => ''], + 'ForceEndFlag' => ['description' => 'Specifies whether to forcibly end the task at the scheduled completion time. If enabled, the task status changes to `Finished` at the scheduled time, even if not all numbers have been called. This is useful for time-sensitive campaigns.
**Note**: A task in the `Finished` state cannot be restarted.
Valid values: `0` (No) and `1` (Yes).

', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The outbound call task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '59', 'title' => ''], + 'Quotiety' => ['description' => 'The abandonment rate, accurate to two decimal places.', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'title' => ''], + 'AutoTriggerTimeStrategy' => ['description' => 'The time periods for interval calling. The value is a comma-separated list of one or more time condition IDs. For example, `9,22`.', 'type' => 'string', 'example' => '9,22', 'title' => ''], + 'RetryStrategy' => ['description' => 'The retry strategy.
**Basic Mode**: The data is a JSON object in the format `{"retry":2,"strategy":[{"round":1,"time":"1-1-1"}]}`. Description:
- `retry`: the number of retries.
- `round`: the sequence number of the retry attempt.
- `time`: the interval for the retry attempt in the D-H-M (Day-Hour-Minute) format.
**Advanced Mode**: This mode requires you to enable the Number Status Recognition service and is available only for automated outbound call tasks. The data is a JSON array in the format `[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]`. Description:
- `condition`: the retry condition.
- `sort`: the order of the retry condition.
Other fields are the same as in Basic Mode.







', 'type' => 'string', 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}', 'title' => ''], + 'CustomerTimeout' => ['description' => 'The customer-side timeout period, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '17', 'title' => ''], + 'Description' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'desc', 'title' => ''], + 'AutoStopDay' => ['description' => 'The date for the scheduled completion. The format is `yyyy-MM-dd`. For example, `2017-02-11`.', 'type' => 'string', 'example' => '2017-02-11', 'title' => ''], + 'TimeStrategy' => ['description' => 'The time periods during which calls are prohibited. The value is a comma-separated list of time condition IDs. For example, `9,22`.', 'type' => 'string', 'example' => '9,22', 'title' => ''], + 'CustomerClidWeight' => ['description' => 'The caller ID ratio configuration.', 'type' => 'string', 'example' => '[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]', 'title' => ''], + 'MinAvailableAgentCount' => ['description' => 'The minimum number of available agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AgentTimeout' => ['description' => 'The agent-side timeout period, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'AnswerRate' => ['description' => 'The initial estimated customer answer rate.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'CustomerMoh' => ['description' => 'The music on hold played to the customer.', 'type' => 'string', 'example' => 'no', 'title' => ''], + 'UserFields' => ['description' => 'The custom fields for the task.', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]', 'title' => ''], + 'CallGroupType' => ['description' => 'The agent assignment mode. Valid values: `1` (By agent ID list) and `2` (By outbound call group).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2025-10-12 18:03:14', 'title' => ''], + 'OverCallLimitCnos' => ['description' => 'The agents who exceeded the call limit.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PauseDuration' => ['description' => 'The duration of the task pause, in minutes. This applies to scheduled start periods.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AutoStop' => ['description' => 'Specifies whether to enable scheduled completion. Valid values: `0` (Disable) and `1` (Enable).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Wrapup' => ['description' => 'The agent wrap-up time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], + 'MaxWaitTime' => ['description' => 'The maximum agent wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], + 'CallRouteStrategy' => ['description' => 'The call routing mode.
- `1`: **Direct to agent**: After the customer answers, the call is assigned directly to an agent. If no agent is available, the call overflows to a configured IVR for queuing. This ensures a direct connection for high-priority customers.
- `2`: **AI to agent**: The call is first routed to the bot configured in the IVR. Based on the interaction, the call is transferred to a human agent. This increases automation and reduces labor costs.

', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StatusTriggerType' => ['description' => 'The trigger type for the status change. Valid values: `0` (System) and `1` (Manual).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CallPriorityStrategy' => ['description' => 'The calling order, specified in a JSON object with the following structure: `{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}`.
- `sort`: Defines the calling priority between numbers pending retry and numbers not yet called.
- `type`: The type of number. Valid values are `retryCall` (numbers pending retry) and `firstCall` (numbers not yet called).
- `desc`: This parameter is used when `type` is `retryCall`. It defines the retry order. Valid values: `0` (prioritizes numbers with fewer retry attempts, such as calling numbers in round 1 before round 2) and `1` (prioritizes numbers with more retry attempts, such as calling numbers in round 5 before round 4).
- `orderType`: This parameter is used when `type` is `firstCall`. It defines the order for new calls. Valid values: `0` (By priority), `1` (Random), and `2` (By import time).



', 'type' => 'string', 'example' => '{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}', 'title' => ''], + 'Type' => ['description' => 'The task type. Valid values: `1` (Predictive outbound call task) and `2` (Automated outbound call task).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'IsRewarm' => ['description' => 'Specifies whether to re-initiate warm-up after a task is paused. Valid values: `0` (Disable) and `1` (Enable).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetryStrategyTimeType' => ['description' => 'The time reference for the retry strategy. Valid values: `1` (Based on the first call time) and `2` (Based on the last call time).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AutoStopTime' => ['description' => 'The scheduled completion time. The format is `HH:mm:ss`. For example, `17:00:00`.', 'type' => 'string', 'example' => '17:00:00'."\n" + ."\n", 'title' => ''], + 'CallLimitStrategy' => ['description' => 'The daily answered call limit for agents. The value is a JSON array. For example, `[{"cnos":["2000","2001"],"limit":"5"}]`.', 'type' => 'string', 'example' => '[{"cnos":["2000","2001"],"limit":"5"}]', 'title' => ''], + 'CallStrategy' => ['description' => 'The agent assignment rule. Valid values:
`1`: Random.
`2`: Sequential.
`3`: Longest time since last call. Assigns the call to the agent with the longest wait time since their last call.
`4`: Longest idle time. Assigns the call to the agent who has been idle the longest.



', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'IvrId' => ['description' => 'The IVR ID. The behavior of this parameter varies based on the scenario.
- **Predictive outbound call task**:
- In `Direct to agent` mode, if no agent is available within a specified time (default: 2 seconds) after the customer answers, the call is queued in this IVR. Calls also overflow to the IVR if an agent fails to answer a transfer (this requires enterprise-level configuration).
- In `AI to agent` mode, the call is first routed to this IVR.
- **Automated outbound call task**: After the customer answers, the call is transferred to this IVR.



', 'type' => 'integer', 'format' => 'int64', 'example' => '133', 'title' => ''], + 'CustomerClidsCategory' => ['description' => 'The type of caller ID to display to the customer. Valid values:
`1`: Landline number
`2`: Mobile number
`4`: Caller ID pool
`5`: IVR number



', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The list of tasks.', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TaskProperties\\": [\\n {\\n \\"CallVariables\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"OverTime\\": \\"example\\",\\n \\"CustomerClidType\\": 1,\\n \\"CustomerVoice\\": \\"example\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name1\\",\\n \\"Cnos\\": \\"1111,2222\\",\\n \\"Concurrency\\": 3,\\n \\"StatusDescription\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AgentGroup\\": \\"WH124\\",\\n \\"CustomerClids\\": \\"02138276106\\",\\n \\"AutoComplete\\": 0,\\n \\"AutoStart\\": 0,\\n \\"CustomerClidWeightFlag\\": 0,\\n \\"Status\\": 2,\\n \\"PauseTime\\": \\"2026-04-20 11:00:00\\",\\n \\"AutoStartDay\\": \\"2017-02-11\\",\\n \\"ClidProperty\\": \\"example\\",\\n \\"RetryStrategyOnlyToday\\": 4,\\n \\"WarmUpDuration\\": 9,\\n \\"PredictAdjust\\": 60,\\n \\"StartTime\\": \\"09:00\\",\\n \\"AutoTaskType\\": 50,\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"ForceEndFlag\\": 0,\\n \\"Id\\": 59,\\n \\"Quotiety\\": 1,\\n \\"AutoTriggerTimeStrategy\\": \\"9,22\\",\\n \\"RetryStrategy\\": \\"{\\\\\\"retry\\\\\\":2,\\\\\\"strategy\\\\\\":[{\\\\\\"round\\\\\\":1,\\\\\\"time\\\\\\":\\\\\\"1-1-1\\\\\\"},{\\\\\\"round\\\\\\":2,\\\\\\"time\\\\\\":\\\\\\"2-2-2\\\\\\"}]}\\",\\n \\"CustomerTimeout\\": 17,\\n \\"Description\\": \\"desc\\",\\n \\"AutoStopDay\\": \\"2017-02-11\\",\\n \\"TimeStrategy\\": \\"9,22\\",\\n \\"CustomerClidWeight\\": \\"[{\\\\\\"number\\\\\\":\\\\\\"123,345\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"},{\\\\\\"number\\\\\\":\\\\\\"567,789\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"MinAvailableAgentCount\\": 2,\\n \\"AgentTimeout\\": 10,\\n \\"AnswerRate\\": 50,\\n \\"CustomerMoh\\": \\"no\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"CallGroupType\\": 1,\\n \\"CreateTime\\": \\"2025-10-12 18:03:14\\",\\n \\"OverCallLimitCnos\\": \\"0\\",\\n \\"PauseDuration\\": 1,\\n \\"AutoStop\\": 0,\\n \\"Wrapup\\": 13,\\n \\"MaxWaitTime\\": 34,\\n \\"CallRouteStrategy\\": 1,\\n \\"StatusTriggerType\\": 0,\\n \\"CallPriorityStrategy\\": \\"{\\\\\\"strategy\\\\\\":[{\\\\\\"sort\\\\\\":1,\\\\\\"type\\\\\\":\\\\\\"retryCall\\\\\\", \\\\\\"desc\\\\\\":0},{\\\\\\"sort\\\\\\":2,\\\\\\"type\\\\\\":\\\\\\"firstCall\\\\\\",\\\\\\"orderType\\\\\\":0}]}\\",\\n \\"Type\\": 1,\\n \\"IsRewarm\\": 0,\\n \\"RetryStrategyTimeType\\": 1,\\n \\"AutoStopTime\\": \\"17:00:00\\\\n\\\\n\\",\\n \\"CallLimitStrategy\\": \\"[{\\\\\\"cnos\\\\\\":[\\\\\\"2000\\\\\\",\\\\\\"2001\\\\\\"],\\\\\\"limit\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"CallStrategy\\": 1,\\n \\"IvrId\\": 133,\\n \\"CustomerClidsCategory\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryWebcallCdr' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of a call record. If you specify this parameter, other filter parameters are ignored, and only the call record with this unique ID is returned.', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the query request. By default, the system queries call records within the current month. If the call record associated with this ID is not from the current month, you must also specify the `startTime` parameter.', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The call status. Valid values:', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24', 'title' => ''], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['description' => 'The province associated with the customer number. Leave this parameter empty to query all provinces. Example: `Beijing`. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['description' => 'The city associated with the customer number. Leave this parameter empty to query all cities. Example: `Beijing`. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the time reference for the `startTime` and `endTime` parameters. This parameter applies only when both `startTime` and `endTime` are specified. Valid values:'."\n" + ."\n" + .'The default value is .', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the query time range, in UNIX timestamp format (in seconds). The `startTime` and `endTime` must be within the same calendar month. The default value is the first day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the query time range, in UNIX timestamp format (in seconds). The `startTime` and `endTime` must be within the same calendar month. The default value is the last day of the current month.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The starting offset for the query results. The value must be greater than or equal to `0`. The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of call records to return. The value must be greater than `0` and no more than `1000`. The default value is `10`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['description' => 'The key of a user-defined parameter for filtering. This parameter must be used with `UserFieldValue` to query for an exact match. Fuzzy matching is not supported. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => 'userFieldkey', 'title' => ''], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of a user-defined parameter for filtering. This parameter must be used with `UserFieldkey` to query for an exact match. Fuzzy matching is not supported. This parameter must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => 'userFieldvalue', 'title' => ''], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['description' => 'The customer number.', 'type' => 'string', 'required' => false, 'example' => '01042003255', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the outbound call group. An ID must be 2 to 20 characters in length. You can specify one or more group IDs, separated by commas. A maximum of 10 group IDs can be specified. Fuzzy matching is not supported.', 'type' => 'string', 'required' => false, 'example' => '233', 'title' => ''], + ], + [ + 'name' => 'CalleeNumber', + 'in' => 'query', + 'schema' => ['description' => 'The agent number.', 'type' => 'string', 'required' => false, 'example' => '01041009283', 'title' => ''], + ], + [ + 'name' => 'DisplayNumber', + 'in' => 'query', + 'schema' => ['description' => 'The actual display number. In an AXB scenario, this is the virtual number used for the outbound call.', 'type' => 'string', 'required' => false, 'example' => '02138276106', 'title' => ''], + ], + [ + 'name' => 'CalleeDisplayNumber', + 'in' => 'query', + 'schema' => ['description' => 'The actual display number of the callee.', 'type' => 'string', 'required' => false, 'example' => '02138276106', 'title' => ''], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['description' => 'The display number (Calling Line Identification).', 'type' => 'string', 'required' => false, 'example' => '02138276106', 'title' => ''], + ], + [ + 'name' => 'CalleeClid', + 'in' => 'query', + 'schema' => ['description' => 'The display number (Calling Line Identification) of the callee.', 'type' => 'string', 'required' => false, 'example' => '02138276106', 'title' => ''], + ], + [ + 'name' => 'ReturnCount', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return the total count of matching call records. Valid values: `0` (No) and `1` (Yes). The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IsRealAnswer', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the call was answered by a human. Valid values: `1` (Yes) and `0` (No).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'An array of webcall call detail records (CDRs).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RealAnswerTime' => ['description' => 'The UNIX timestamp, in seconds, for when a human answered the call.', 'type' => 'string', 'example' => '1775024775', 'title' => ''], + 'NumberTrunk' => ['description' => 'The trunk number.', 'type' => 'string', 'example' => '42003255', 'title' => ''], + 'CustomerProvince' => ['description' => 'The province associated with the customer\'s number.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '13354', 'title' => ''], + 'DisplayNumber' => ['description' => 'The displayed caller ID. In an AXB number substitution scenario, this is the virtual number.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'EndTime' => ['description' => 'The UNIX timestamp, in seconds, for when the call ended.', 'type' => 'string', 'example' => '1774822312', 'title' => ''], + 'Clid' => ['description' => 'The caller ID.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '2000', 'title' => ''], + 'TrunkGroupKey' => ['description' => 'The trunk group ID.', 'type' => 'string', 'example' => '30019', 'title' => ''], + 'CalleeDisplayNumber' => ['description' => 'The displayed number of the callee.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'DetailRingingTime' => ['description' => 'The time when the transferred call started ringing.', 'type' => 'string', 'example' => '1774822303', 'title' => ''], + 'CallType' => ['description' => 'The call type.', 'type' => 'string', 'example' => 'webcall', 'title' => ''], + 'Gno' => ['description' => 'The agent\'s outbound call group ID.', 'type' => 'string', 'example' => 'WH333', 'title' => ''], + 'AnswerTime' => ['description' => 'The UNIX timestamp, in seconds, for when the system answered the call.', 'type' => 'string', 'example' => '1774822302', 'title' => ''], + 'StatusCode' => ['description' => 'The status code that corresponds to the `Status` parameter.', 'type' => 'string', 'example' => '24', 'title' => ''], + 'RequestUniqueId' => ['description' => 'A user-defined call ID.', 'type' => 'string', 'example' => '214b76605a43d02f4aab4e61cfa63128', 'title' => ''], + 'CalleeClid' => ['description' => 'The callee\'s caller ID.', 'type' => 'string', 'example' => '02138276106', 'title' => ''], + 'WaitDuration' => ['description' => 'The wait duration, in seconds.', 'type' => 'string', 'example' => '6', 'title' => ''], + 'EndReason' => ['description' => 'A code indicating why the connected call ended. Valid values: `1000` (primary party disconnected), `1001` (secondary party disconnected), and `1002` (call was forcibly disconnected).', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Qno' => ['description' => 'The queue number.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'RecordFile' => [ + 'description' => 'An array of recordings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['description' => '1. `1`: `audio mixing`, `2`: `multi-track recording` (saves two mono WAV files), `3`: `voicemail`, or `5`: `multi-track recording` (saves one dual-channel WAV file).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'Specifies the file type. Valid values: `record` (a recording) and `voicemail`.', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'File' => ['description' => 'The name of the recording file.', 'type' => 'string', 'example' => ' name3', 'title' => ''], + ], + 'description' => 'The details of a recording.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'CustomerNumber' => ['description' => 'The customer\'s phone number in the Chinese mainland. It can be a landline (area code plus number, without hyphens), an 11-digit mobile number, or a virtual number with an extension.', 'type' => 'string', 'example' => '18701051984', 'title' => ''], + 'CalleeRingingTime' => ['description' => 'The UNIX timestamp, in seconds, for when the customer\'s phone started ringing.', 'type' => 'string', 'example' => '1774822302', 'title' => ''], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'DownGrade' => ['description' => 'Indicates whether a call downgrade occurred. Valid values: `0` (No) and `1` (Yes).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IvrName' => ['description' => 'A user-defined name for the IVR.', 'type' => 'string', 'example' => 'webcall', 'title' => ''], + 'Status' => ['description' => 'A human-readable description of the call\'s outcome. For example, "Customer answered".', 'type' => 'string', 'example' => '客户接听', 'title' => ''], + 'UniqueId' => ['description' => 'The unique call ID.', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12', 'title' => ''], + 'SipCause' => ['description' => 'The SIP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'CustomerCity' => ['description' => 'The city associated with the customer\'s number.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'CallId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => '4e18e73a-af6a-4a77-92ea-628a6effd64b', 'title' => ''], + 'StartTime' => ['description' => 'The UNIX timestamp, in seconds, for when the call entered the system.', 'type' => 'string', 'example' => '1774822302', 'title' => ''], + 'SipCauseStr' => ['description' => 'The call result description that corresponds to the SIP status code.', 'type' => 'string', 'example' => '处理成功', 'title' => ''], + 'TaskFileId' => ['description' => 'The ID of the task file.', 'type' => 'string', 'example' => '12144', 'title' => ''], + 'IsRealAnswer' => ['description' => 'Indicates if a human answered the call. Valid values: `1` (Yes), `0` (No), or an empty string.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DownGradeCounts' => ['description' => 'The number of call downgrades.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'CalleeNumber' => ['description' => 'The callee\'s number. It can be a landline (area code plus number, without hyphens) or an 11-digit mobile number.', 'type' => 'string', 'example' => '0104100596', 'title' => ''], + 'TotalDuration' => ['description' => 'The total call duration, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'BridgeDuration' => ['description' => 'The duration of the connected call, in seconds.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Id' => ['description' => 'The unique ID of this call detail record.', 'type' => 'string', 'example' => '14454', 'title' => ''], + 'BridgeTime' => ['description' => 'The UNIX timestamp, in seconds, for when the agent answered the call.', 'type' => 'string', 'example' => '1774822308', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code of the API request. A value of `OK` indicates success.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudQueryWebcallCdr', + 'summary' => 'Use this API to query webCall call records.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"RealAnswerTime\\": \\"1775024775\\",\\n \\"NumberTrunk\\": \\"42003255\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"TaskId\\": \\"13354\\",\\n \\"DisplayNumber\\": \\"02138276106\\",\\n \\"EndTime\\": \\"1774822312\\",\\n \\"Clid\\": \\"02138276106\\",\\n \\"Cno\\": \\"2000\\",\\n \\"TrunkGroupKey\\": \\"30019\\",\\n \\"CalleeDisplayNumber\\": \\"02138276106\\",\\n \\"DetailRingingTime\\": \\"1774822303\\",\\n \\"CallType\\": \\"webcall\\",\\n \\"Gno\\": \\"WH333\\",\\n \\"AnswerTime\\": \\"1774822302\\",\\n \\"StatusCode\\": \\"24\\",\\n \\"RequestUniqueId\\": \\"214b76605a43d02f4aab4e61cfa63128\\",\\n \\"CalleeClid\\": \\"02138276106\\",\\n \\"WaitDuration\\": \\"6\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"1000\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\" name3\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"18701051984\\",\\n \\"CalleeRingingTime\\": \\"1774822302\\",\\n \\"AgentName\\": \\"张三\\",\\n \\"DownGrade\\": \\"0\\",\\n \\"IvrName\\": \\"webcall\\",\\n \\"Status\\": \\"客户接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"SipCause\\": \\"200\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"CallId\\": \\"4e18e73a-af6a-4a77-92ea-628a6effd64b\\",\\n \\"StartTime\\": \\"1774822302\\",\\n \\"SipCauseStr\\": \\"处理成功\\",\\n \\"TaskFileId\\": \\"12144\\",\\n \\"IsRealAnswer\\": \\"1\\",\\n \\"DownGradeCounts\\": \\"0\\",\\n \\"CalleeNumber\\": \\"0104100596\\",\\n \\"TotalDuration\\": \\"10\\",\\n \\"BridgeDuration\\": \\"4\\",\\n \\"Id\\": \\"14454\\",\\n \\"BridgeTime\\": \\"1774822308\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudStartTask' => [ + 'summary' => 'Manually starts an outbound task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the enterprise.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8001654', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the outbound task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '32', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denied error.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Message' => ['description' => 'The status code message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation, where 0 indicates success and 1 indicates failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code of the request.'."\n" + ."\n" + .'- A value of `OK` indicates that the request succeeded.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudStartTask', + 'description' => 'Starts a predictive outbound task.'."\n" + ."\n" + .'An enterprise can have a maximum of 10 running or paused tasks at a time.'."\n" + ."\n" + .'An agent can be in only one running or paused task at a time.'."\n" + ."\n" + .'By default, a task requires at least 10 available agents, excluding agents in a busy state. Otherwise, the task automatically pauses after it starts.'."\n" + ."\n" + .'If the average agent answer delay exceeds 2 seconds while the task is running, the system automatically terminates the task.'."\n" + ."\n" + .'If the call connection rate is too low while the task is running, the system automatically terminates the task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CloudUnassignAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['description' => 'The number of the outbound group.', 'type' => 'string', 'required' => true, 'example' => 'WH123', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The number of the agent to unassign.', 'type' => 'string', 'required' => true, 'example' => '12221', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'A value of `0` indicates success. Other values indicate failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudUnassignAgentGroup', + 'summary' => 'Removes the association between an outbound group and an agent.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudUpdateAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID. The value must be a positive integer with 3 to 10 digits.', 'type' => 'string', 'required' => true, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s name, which must be URL-encoded in UTF-8.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s area code.', 'type' => 'string', 'required' => false, 'example' => '010', 'title' => ''], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to activate the agent. Valid values: `0`: Inactive. `1`: Active. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AgentType', + 'in' => 'query', + 'schema' => ['description' => 'The agent type. Valid values: `1`: Phone agent. `2`: PC-based agent. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Power', + 'in' => 'query', + 'schema' => ['description' => 'The agent\'s role. Valid values: `1`: Supervisor. `0`: Standard agent. The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['description' => 'The call permissions. Valid values: `0`: Unrestricted. `1`: Domestic long-distance. `2`: Local city. `3`: Internal calls. The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['description' => 'The wrap-up time, in seconds. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '22', 'title' => ''], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether outbound calls are allowed. Valid values: `0`: Not allowed. `1`: Allowed. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ObClidType', + 'in' => 'query', + 'schema' => ['description' => 'The outbound caller ID rule. Valid values: `1`: Default. `2`: Random. `3`: By area code. `4`: Dynamic. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ObClid', + 'in' => 'query', + 'schema' => ['description' => 'The pass-through number. This can be a corporate trunk number or a pre-configured outbound caller ID. This parameter is required when `ObClidType` is set to `2` or `3`.', 'type' => 'string', 'required' => false, 'example' => '22223333', 'title' => ''], + ], + [ + 'name' => 'IsRandom', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use a random outbound caller ID. Valid values: `0`: No. `1`: Yes. This parameter is required when `ObClidType` is set to `4`. The default value is `0`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ObClidProperty', + 'in' => 'query', + 'schema' => ['description' => 'The properties of the outbound caller ID. Example: {"isMatchCapital":0,"areaCodeRule":1}. When ObClidType is `4`, isMatchCapital specifies whether to match a provincial capital (`1`: Yes, `0`: No), and areaCodeRule specifies the area code matching rule (`1`: agent\'s area code, `2`: customer\'s area code). Note: The JSON string must be URL-encoded.', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1}', 'title' => ''], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to record inbound calls. Valid values: `0`: Do not record. `1`: Record. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to record outbound calls. Valid values: `0`: Do not record. `1`: Record. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SkillIds', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of skill IDs to assign to the agent. Example: "1,2,3". To remove all skills from the agent, set this value to "0". If you assign any skills, you must also specify the `SkillLevels` parameter.', 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], + ], + [ + 'name' => 'SkillLevels', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of levels for the skills specified in `SkillIds`. The order of levels must match the order of IDs. A smaller value indicates a higher skill level. For example, if `SkillIds` is "1,2,3" and `SkillLevels` is "5,1,1", the levels for skills 1, 2, and 3 are 5, 1, and 1, respectively.', 'type' => 'string', 'required' => false, 'example' => '5,1,1', 'title' => ''], + ], + [ + 'name' => 'IsAsr', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable ASR transcription. Valid values: `0`: Disable. `1`: Enable. The default value is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IsQualityCheck', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable agent quality check. Valid values: `0`: Disable. `1`: Enable. The default value is `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'WebrtcUrlType', + 'in' => 'query', + 'schema' => ['description' => 'The URL type returned for the WebRTC softphone. Valid values: `0`: Corporate default. `1`: Public domain name. `2`: Leased line domain name. `3`: Public IP. `4`: Leased line IP.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IsObRemember', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable outbound caller ID memory. Valid values: `0`: Disable. `1`: Enable. The default value is `1`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'A comment or description for the agent.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], + ], + [ + 'name' => 'PermitObPreviewTime', + 'in' => 'query', + 'schema' => ['description' => 'The time range during which outbound calls are permitted. Format: `HH:mm,HH:mm`.', 'type' => 'string', 'required' => false, 'example' => '08:00,20:00', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details of the request failure.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Agent' => [ + 'description' => 'The agent configuration.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The agent\'s status. Valid values: `0`: offline, `1`: online.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'IsQualityCheck' => ['description' => 'Whether the quality check feature is enabled for the agent. Valid values: `0`: disabled, `1`: enabled. The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CallPower' => ['description' => 'The agent\'s calling permissions. Valid values: `0`: unrestricted, `1`: domestic long-distance, `2`: local, `3`: internal. The default value is `0`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObClid' => ['description' => 'The outbound caller ID.', 'type' => 'string', 'example' => '22223333', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the agent was created, in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'IbRecord' => ['description' => 'Whether inbound calls are recorded. Valid values: `0`: disabled, `1`: enabled. The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'BindTelType' => ['description' => 'The type of phone bound to the agent. Valid values: `1`: landline, `2`: mobile, `3`: extension, `4`: softphone.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Wrapup' => ['description' => 'The wrap-up time, in seconds. The default value is 10.', 'type' => 'string', 'example' => '22', 'title' => ''], + 'ObRecord' => ['description' => 'Whether outbound calls are recorded. Valid values: `0`: disabled, `1`: enabled. The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + 'Name' => ['description' => 'The agent\'s name.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'IsAsr' => ['description' => 'Whether ASR transcription is enabled. Valid values: `0`: disabled, `1`: enabled. The default value is `0`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AgentType' => ['description' => 'The type of the agent. Valid values: `1`: phone-based agent, `2`: PC-based agent. The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Active' => ['description' => 'Whether the agent is active. Valid values: `0`: inactive, `1`: active. The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ObClidType' => ['description' => 'The outbound caller ID rule. Valid values: `1`: enterprise default, `2`: random, `3`: by area code, `4`: dynamic.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'WebrtcUrlType' => ['description' => 'The URL type for the WebRTC softphone. Valid values: `0`: enterprise default, `1`: public domain, `2`: leased line domain, `3`: public IP, `4`: leased line IP.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AreaCode' => ['description' => 'The area code.', 'type' => 'string', 'example' => '010', 'title' => ''], + 'ObClidProperty' => ['description' => 'The properties of the outbound caller ID rule, in JSON format.', 'type' => 'string', 'example' => '{"isMatchCapital":0,"areaCodeRule":1}', 'title' => ''], + 'BindTel' => ['description' => 'The phone number bound to the agent.', 'type' => 'string', 'example' => '22223333', 'title' => ''], + 'Id' => ['description' => 'The unique ID for the agent.', 'type' => 'string', 'example' => '100012', 'title' => ''], + 'Power' => ['description' => 'The agent\'s role. Valid values: `0`: standard agent, `1`: supervisor. The default value is `0`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IsOb' => ['description' => 'Whether the agent can make outbound calls. Valid values: `0`: not allowed, `1`: allowed. The default value is `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'AgentSkills' => [ + 'description' => 'A list of the agent\'s skills.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Cno' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the skill was assigned to the agent, in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-04-20 10:00:00', 'title' => ''], + 'SkillId' => ['description' => 'The skill ID.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the agent-skill assignment.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'AgentId' => ['description' => 'The unique ID for the agent.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'EnterpriseId' => ['description' => 'The enterprise ID.', 'type' => 'string', 'example' => '7000002', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- `OK` indicates that the request was successful.'."\n" + ."\n" + .'- For other status codes, see [API error codes](https://help.aliyun.com/zh/vms/developer-reference/api-error-code?spm=a2c4g.11186623.0.0.321526dckd3diO).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudUpdateAgent', + 'summary' => 'Update the agent\'s basic information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Agent\\": {\\n \\"Status\\": \\"0\\",\\n \\"IsQualityCheck\\": \\"1\\",\\n \\"CallPower\\": \\"1\\",\\n \\"ObClid\\": \\"22223333\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"IbRecord\\": \\"1\\",\\n \\"BindTelType\\": \\"1\\",\\n \\"Wrapup\\": \\"22\\",\\n \\"ObRecord\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"张三\\",\\n \\"IsAsr\\": \\"1\\",\\n \\"AgentType\\": \\"1\\",\\n \\"Active\\": \\"1\\",\\n \\"ObClidType\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"1\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"ObClidProperty\\": \\"{\\\\\\"isMatchCapital\\\\\\":0,\\\\\\"areaCodeRule\\\\\\":1}\\",\\n \\"BindTel\\": \\"22223333\\",\\n \\"Id\\": \\"100012\\",\\n \\"Power\\": \\"1\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"AgentSkills\\": [\\n {\\n \\"SkillLevel\\": \\"2\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"SkillId\\": \\"111\\",\\n \\"Id\\": \\"123\\",\\n \\"AgentId\\": \\"1234\\",\\n \\"EnterpriseId\\": \\"7000002\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudUpdateTask' => [ + 'summary' => 'Edit an outbound call task\'s basic information.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the outbound task.', 'type' => 'string', 'required' => true, 'example' => '133224', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The task name. It must be URL-encoded in UTF-8 and contain fewer than 50 characters.', 'type' => 'string', 'required' => false, 'example' => '任务名称-1', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The task description. It must be URL-encoded in UTF-8 and contain fewer than 200 characters.', 'type' => 'string', 'required' => false, 'example' => '描述任务信息', 'title' => ''], + ], + [ + 'name' => 'AutoStart', + 'in' => 'query', + 'schema' => ['description' => 'Determines if the task starts automatically. Valid values: `0` (Disable) and `1` (Enable). Default: `0`. If set to `1`, `AutoStartDay` and `AutoStartTime` become active, and at least one must be specified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'AutoStartDay', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled start date for the task, effective only when `AutoStart` is `1`. If unspecified, the task starts today at the time set in `AutoStartTime`. The date must be in the `YYYY-MM-DD` format. Example: `2026-01-01`.', 'type' => 'string', 'required' => false, 'example' => '2026-01-01', 'title' => ''], + ], + [ + 'name' => 'AutoStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled start time for the task, effective only when `AutoStart` is `1`. If unspecified, the task defaults to `00:00:00` on the date set in `AutoStartDay`. The time must be in the `HH:mm:ss` format. Example: `08:00:00`.', 'type' => 'string', 'required' => false, 'example' => '08:00:00', 'title' => ''], + ], + [ + 'name' => 'AutoStop', + 'in' => 'query', + 'schema' => ['description' => 'Determines if the task stops automatically. Valid values: `0` (Disable) and `1` (Enable). Default: `0`. If set to `1`, `AutoStopDay` and `AutoStopTime` become active, and at least one must be specified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'AutoStopDay', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled completion date for the task, effective only when `AutoStop` is `1`. If unspecified, the task completes today at the time set in `AutoStopTime`. The date must be in the `YYYY-MM-DD` format. Example: `2026-01-01`.', 'type' => 'string', 'required' => false, 'example' => '定时完成日期；autoStop=1时生效。参数不传入时默认在当天的autoStopTime定时完成。格式：yyyy-MM-dd，如：2026-01-01', 'title' => ''], + ], + [ + 'name' => 'AutoStopTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled completion time for the task, effective only when `AutoStop` is `1`. If unspecified, the task defaults to `23:59:59` on the date set in `AutoStopDay`. The time must be in the `HH:mm:ss` format. Example: `17:00:00`.', 'type' => 'string', 'required' => false, 'example' => '17:00:00', 'title' => ''], + ], + [ + 'name' => 'ForceEndFlag', + 'in' => 'query', + 'schema' => ['description' => 'Determines if the task is forcibly ended at its scheduled completion time. This parameter takes effect only when `AutoStop` is set to `1`. Valid values: `0` (Disable) and `1` (Enable). Default value: `0`. If enabled, the task status is set to `Ended` when the scheduled completion time is reached, regardless of whether all numbers in the task have been called. Use this for scenarios with strict time limits. Note: A task with the `Ended` status cannot be restarted.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'AutoTaskType', + 'in' => 'query', + 'schema' => ['description' => 'The call scheduling type. Valid values: `0` (Continuous calling) and `1` (Interval calling). Default value: `0`. This parameter is used with `AutoStart` and `AutoStop`. Set this to `1` if the task should run only during specific daily time windows.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'AutoTriggerTimeStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The time windows for interval calling. This parameter is required when `AutoTaskType` is set to `1`. The value is a comma-separated list of time condition IDs. Example: `9,22`. Note: Obtain time condition IDs by calling the relevant query API.', 'type' => 'string', 'required' => false, 'example' => '9,22', 'title' => ''], + ], + [ + 'name' => 'AutoComplete', + 'in' => 'query', + 'schema' => ['description' => 'Determines if the task is automatically completed. Valid values: `0` (Disable) and `1` (Enable). Default value: `1`.
'."\n" + .'\\- `1` (Enable): Automatically completes the task and its status is set to `Ended` after all numbers are called.
'."\n" + .'\\- `0` (Disable): Automatically pauses the task and its status is set to `Paused` after all numbers are called.
'."\n" + .'Note: A task with the `Ended` status cannot be restarted.


', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'RetryStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The retry strategy. The system automatically selects Basic or Advanced Mode based on the parameter\'s format.
- **Basic Mode**: The value is a JSON object. Example: `{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}`
- `retry`: The number of retry attempts.
- `round`: The retry attempt number.
- `time`: The interval for the retry attempt, in the `D-H-M` format (Days-Hours-Minutes).
- **Advanced Mode**: This mode requires the Number Status Recognition service to be enabled. The value is a JSON array. Example: `[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]`
- `condition`: The retry condition.
- `sort`: The priority of the retry condition.
- Other fields are the same as in Basic Mode.
Note: If retries are based on the first call time, the interval for each subsequent retry must be longer than the previous one.








', 'type' => 'string', 'required' => false, 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}', 'title' => ''], + ], + [ + 'name' => 'RetryStrategyTimeType', + 'in' => 'query', + 'schema' => ['description' => 'The time base for the retry strategy, effective only when a retry strategy is configured. Valid values: `1` (Based on the first call time) and `2` (Based on the last call time). Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'RetryStrategyOnlyToday', + 'in' => 'query', + 'schema' => ['description' => 'Restricts the task to the current day. This setting determines which pending numbers are cleared at the end of the day.
- `0`: Disable. (Default)
- `1`: Enable. Deletes both numbers pending retry and numbers not yet called.
- `2`: Enable. Deletes only numbers pending retry.
- `3`: Enable. Deletes only numbers not yet called.



', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'CallPriorityStrategy', + 'in' => 'query', + 'schema' => ['description' => 'Defines the calling priority as a JSON object. Example: `{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}`
- `sort`: The calling order for numbers pending retry and numbers not yet called.
- `type`: The type of numbers to prioritize. Valid values: `retryCall` (numbers pending retry) and `firstCall` (numbers not yet called).
- When `type` is `retryCall`:
- `desc`: `0` prioritizes numbers with fewer retry attempts (for example, call numbers for attempt 1 before attempt 2). `1` prioritizes numbers with more retry attempts (for example, call numbers for attempt 5 before attempt 4).
- When `type` is `firstCall`:
- `orderType`: Defines the calling order. `0` for sequential by priority, `1` for random, and `2` for sequential by import time.





', 'type' => 'string', 'required' => false, 'example' => '{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}', 'title' => ''], + ], + [ + 'name' => 'CustomerClidsCategory', + 'in' => 'query', + 'schema' => ['description' => 'The type of caller ID. Valid values:
- `1`: Landline caller ID
- `2`: Mobile caller ID
- `4`: Number pool
- `5`: Caller ID navigation
Note: We recommend using caller ID navigation for flexible control over caller ID strategies. Other types will be phased out.




', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'CustomerClids', + 'in' => 'query', + 'schema' => ['description' => 'The list of caller ID numbers. This parameter is required when `CustomerClidsCategory` is set to `1` or `2`. Separate multiple numbers with commas (,). This parameter is not recommended for use.', 'type' => 'string', 'required' => false, 'example' => '64203667,23434294', 'title' => ''], + ], + [ + 'name' => 'CustomerClidType', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID selection rule. Effective when `CustomerClidsCategory` is `1` or `2`.
- `1`: Random (Default)
- `2`: By area code
This parameter is not recommended for use.


', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ClidProperty', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID selection properties. Effective when `CustomerClidType` is `2`. Specifies rules such as the default area code and whether to match the provincial capital. The value must be in a JSON format. Example: `{"defaultAreaCode":"010", "isMatchCapital":"1"}`. This parameter is not recommended for use.', 'type' => 'string', 'required' => false, 'example' => '{"defaultAreaCode":"010", "isMatchCapital":"1"}', 'title' => ''], + ], + [ + 'name' => 'CustomerClidWeightFlag', + 'in' => 'query', + 'schema' => ['description' => 'Enables or disables weighted distribution for caller ID numbers. Effective when `CustomerClidsCategory` is `1`.
- `0`: Disable (Default)
- `1`: Enable
This parameter is not recommended for use.


', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'CustomerClidWeight', + 'in' => 'query', + 'schema' => ['description' => 'The weighted distribution settings for caller ID numbers. Effective when `CustomerClidsCategory` is `1` and `CustomerClidWeightFlag` is `1`. The value must be a JSON array. Example: `[{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]`. This parameter is not recommended for use.', 'type' => 'string', 'required' => false, 'example' => '[{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]', 'title' => ''], + ], + [ + 'name' => 'CustomerClidsGroup', + 'in' => 'query', + 'schema' => ['description' => 'The name of the number pool or the identifier of the caller ID navigation. This parameter is required when `CustomerClidsCategory` is set to `4` or `5`.
- If `CustomerClidsCategory` is `4`, specify the name of the number pool.
- If `CustomerClidsCategory` is `5`, specify the identifier of the caller ID navigation.

', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], + ], + [ + 'name' => 'CustomerTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The customer ringing timeout. Unit: seconds. Default: 30. Range: 5–60.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55', 'title' => ''], + ], + [ + 'name' => 'CallRouteStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The call routing strategy. Valid values:
- `1` (Direct to agent): After the customer answers, the call is directly routed to an agent. If no agent is available, the call can be transferred to an IVR (requires IVR configuration). This ensures a direct connection for high-priority customers.
- `2` (AI to agent transfer): After the customer answers, the call is routed to a bot configured in the IVR. The bot transfers the call to an agent based on the interaction. This improves automation and reduces manual costs.

', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IvrId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the IVR. You must specify either `IvrId` or `IvrName`. If both are provided, `IvrId` takes precedence. When you create an automated outbound task, you must specify either `IvrId` or `IvrName`.
- Predictive dialing scenario: If an available agent is not found within a specific time (default: 2 seconds) after the customer answers, the call is transferred to this IVR to queue for an agent. The system also supports transferring the call to the IVR if an agent does not answer. This requires an enterprise-level configuration.
- Automated outbound scenario: After the customer answers, the call is transferred to this IVR.

', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13', 'title' => ''], + ], + [ + 'name' => 'IvrName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the IVR. You must specify `IvrId` or `IvrName`. If both are provided, `IvrId` takes precedence. This parameter is required for automated outbound tasks.', 'type' => 'string', 'required' => false, 'example' => 'IvrName1', 'title' => ''], + ], + [ + 'name' => 'Concurrency', + 'in' => 'query', + 'schema' => ['description' => 'The maximum concurrent calls for this task. If `type` is `1`, setting this parameter to `0` means no limit. We recommend that you configure this parameter if you have fewer than 10 agents.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'UserFields', + 'in' => 'query', + 'schema' => ['description' => 'The custom fields for the task. The value must be a JSON array. Each element in the array must be a single key-value pair, such as `{"key": "value"}`. If an element contains multiple pairs, only the first pair is used. Default value: empty. Example: `[{"name":"1234"},{"name1":"12345"}]`. Note: A single field\'s value cannot exceed 1,000 characters.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"1234"},{"name1":"12345"}] ', 'title' => ''], + ], + [ + 'name' => 'CallVariables', + 'in' => 'query', + 'schema' => ['description' => 'Variables for the agent channel, passed as SIP headers. The value must be a JSON array with a maximum of five variables. Default value: empty. Example: `[{"name":"abcdefg","value":"${cdr_enterprise_id}"}]`. Note: The value of a single field cannot exceed 1,000 characters in length.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] ', 'title' => ''], + ], + [ + 'name' => 'TimeStrategy', + 'in' => 'query', + 'schema' => ['description' => 'Defines no-call time windows during which calls are prohibited. The value is a comma-separated list of time condition IDs. Example: `9,22`. Note: Obtain time condition IDs by calling the relevant query API.', 'type' => 'string', 'required' => false, 'example' => '9,22', 'title' => ''], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['description' => 'A list of agent IDs. This parameter is required when `callGroupType` is `1`. Separate multiple agent IDs with commas (,). Note: An agent can be part of only one running task at a time.', 'type' => 'string', 'required' => false, 'example' => '1111,2222', 'title' => ''], + ], + [ + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => ['description' => 'The outbound group ID. This parameter is required when `callGroupType` is `2`. Note: An agent group can be bound to multiple tasks, but can be active in only one running task at a time.', 'type' => 'string', 'required' => false, 'example' => '6,7', 'title' => ''], + ], + [ + 'name' => 'CallStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The agent allocation rule. Valid values:
- `1`: Random (Default)
- `2`: Sequential
- `3`: Longest agent offline time (total time since the last call ended)
- `4`: Longest agent idle duration (time since the agent\'s status last changed to idle)



', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AgentTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The time an agent has to answer a routed call. Unit: seconds. Default: 10. Range: 5–60.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['description' => 'The agent wrap-up time. Unit: seconds. Default value: 30. Valid values: 1 to 10,800. This value affects the call batch size; a larger value reduces the number of calls made per batch.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'MaxWaitTime', + 'in' => 'query', + 'schema' => ['description' => 'The maximum allowed agent idle time. Unit: seconds. Default value: 40. Valid values: 10 to 600. If the average agent idle time exceeds this value, the system increases the call batch size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40', 'title' => ''], + ], + [ + 'name' => 'MinAvailableAgentCount', + 'in' => 'query', + 'schema' => ['description' => 'The minimum number of available agents required to run the task. Default value: 10. Valid values: 1 to 10. If the number of available agents drops below this threshold, the task automatically pauses to prevent abandoned calls.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Quotiety', + 'in' => 'query', + 'schema' => ['description' => 'The target abandonment rate (as a percentage). Default value: 1. The value must be greater than 0 and less than or equal to 20. The value can have up to two decimal places. A lower value results in fewer concurrent calls, while a higher value increases call volume and agent utilization.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '19.00', 'title' => ''], + ], + [ + 'name' => 'PredictAdjust', + 'in' => 'query', + 'schema' => ['description' => 'The over-dial rate, as a percentage. Default: 100. Range: 50–400.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'CallLimitStrategy', + 'in' => 'query', + 'schema' => ['description' => 'Sets a daily call limit for agents. The value must be a JSON array. Example: `[{"cnos":["2000","2001"],"limit":"5"}]`.
Note: This feature requires an enterprise-level configuration. Daily call counting begins only after this feature is enabled and a limit is set.
', 'type' => 'string', 'required' => false, 'example' => '[{"cnos":["2000","2001"],"limit":"5"}] ', 'title' => ''], + ], + [ + 'name' => 'CustomerMoh', + 'in' => 'query', + 'schema' => ['description' => 'The music on hold for the customer. This audio is played while the customer waits for an agent to answer after the call is connected. If unspecified, no music is played. You can use public or enterprise audio files. The value is the path to the audio file. Example: `60000011533526918819`.', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819', 'title' => ''], + ], + [ + 'name' => 'CustomerVoice', + 'in' => 'query', + 'schema' => ['description' => 'The prompt played to the customer. This audio is played after the customer answers but before the call is transferred to an agent. The system searches for an agent only after the prompt finishes. If unspecified, no prompt is played. You can use public or enterprise audio files. The value is the path to the audio file. Example: `60000011533526918819`.', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819', 'title' => ''], + ], + [ + 'name' => 'AnswerRate', + 'in' => 'query', + 'schema' => ['description' => 'The initial estimated answer rate (as a percentage). Default: 50. Range: 1–100. The call frequency during the warm-up phase is calculated based on this rate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'WarmUpDuration', + 'in' => 'query', + 'schema' => ['description' => 'The warm-up duration for the task. Unit: seconds. Default: 300. Range: 60–600.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '370', 'title' => ''], + ], + [ + 'name' => 'IsRewarm', + 'in' => 'query', + 'schema' => ['description' => 'Determines if the task re-warms up after being resumed from a paused state.
- `0`: Disable
- `1`: Enable (Default)

', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'OverTime' => ['description' => 'The end time of the task.', 'type' => 'string', 'example' => '2026-01-0114:00:00', 'title' => ''], + 'CustomerTimeout' => ['description' => 'The customer timeout, in seconds.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Description' => ['description' => 'The task description.', 'type' => 'string', 'example' => '任务描述', 'title' => ''], + 'AutoStopDay' => ['description' => 'The scheduled completion date. The format is `yyyy-MM-dd`.', 'type' => 'string', 'example' => '2026-02-11', 'title' => ''], + 'AgentTimeout' => ['description' => 'The agent timeout, in seconds.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'EnterpriseId' => ['description' => 'The call center ID.', 'type' => 'string', 'example' => '8001654', 'title' => ''], + 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => '任务名称', 'title' => ''], + 'Cnos' => ['description' => 'The list of agent IDs.', 'type' => 'string', 'example' => '1111', 'title' => ''], + 'Concurrency' => ['description' => 'The concurrency limit.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'CustomerClids' => ['description' => 'The list of caller IDs.', 'type' => 'string', 'example' => '42366453,74565327', 'title' => ''], + 'AutoComplete' => ['description' => 'Whether the task is automatically completed. Valid values: `0` (Disabled) and `1` (Enabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AutoStart' => ['description' => 'Specifies whether the task automatically starts at the scheduled time. Valid values: `0` (Disabled) and `1` (Enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AnswerRate' => ['description' => 'The initial estimated answer rate.', 'type' => 'string', 'example' => '55', 'title' => ''], + 'Status' => ['description' => 'The task status. Valid values: `0` (Initial), `1` (Running), `2` (Paused), and `3` (Ended).', 'type' => 'string', 'example' => '3', 'title' => ''], + 'CustomerMoh' => ['description' => 'The music on hold for the customer.', 'type' => 'string', 'example' => '客户侧等待音', 'title' => ''], + 'AutoStartDay' => ['description' => 'The scheduled start date. The format is `yyyy-MM-dd`.', 'type' => 'string', 'example' => '2026-02-11', 'title' => ''], + 'UserFields' => ['description' => 'The custom fields for the task, as a JSON array.', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]', 'title' => ''], + 'PredictAdjust' => ['description' => 'The over-dialing rate.', 'type' => 'string', 'example' => '超呼率', 'title' => ''], + 'CreateTime' => ['description' => 'The task creation time. The format is `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2026-02-10 14:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2026-02-10 15:00:00', 'title' => ''], + 'AutoStop' => ['description' => 'Specifies whether the task automatically stops at the scheduled time. Valid values: `0` (Disabled) and `1` (Enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Wrapup' => ['description' => 'The wrap-up time, in seconds.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'MaxWaitTime' => ['description' => 'The maximum agent wait time, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Type' => ['description' => 'The task type. Valid values: `1` (Predictive dialing task) and `2` (Automated outbound task).', 'type' => 'string', 'example' => '2', 'title' => ''], + 'AutoStartTime' => ['description' => 'The scheduled start time. The format is `HH:mm:ss`. For example, `08:00:00`.', 'type' => 'string', 'example' => '08:00:00', 'title' => ''], + 'IsRandom' => ['description' => 'Whether to make calls in random order. Valid values: `0` (Disabled) and `1` (Enabled).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AutoStopTime' => ['description' => 'The scheduled completion time. The format is `HH:mm:ss`. For example, `17:00:00`.', 'type' => 'string', 'example' => '17:00:00', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'IvrId' => ['description' => 'The IVR ID.', 'type' => 'string', 'example' => '133', 'title' => ''], + 'Quotiety' => ['description' => 'The nuisance call rate, accurate to two decimal places.', 'type' => 'string', 'example' => '0.33', 'title' => ''], + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => 'The response that contains the details of the task.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudUpdateTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OverTime\\": \\"2026-01-0114:00:00\\",\\n \\"CustomerTimeout\\": \\"5\\",\\n \\"Description\\": \\"任务描述\\",\\n \\"AutoStopDay\\": \\"2026-02-11\\",\\n \\"AgentTimeout\\": \\"30\\",\\n \\"EnterpriseId\\": \\"8001654\\",\\n \\"Name\\": \\"任务名称\\",\\n \\"Cnos\\": \\"1111\\",\\n \\"Concurrency\\": \\"10\\",\\n \\"CustomerClids\\": \\"42366453,74565327\\",\\n \\"AutoComplete\\": 0,\\n \\"AutoStart\\": \\"0\\",\\n \\"AnswerRate\\": \\"55\\",\\n \\"Status\\": \\"3\\",\\n \\"CustomerMoh\\": \\"客户侧等待音\\",\\n \\"AutoStartDay\\": \\"2026-02-11\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"PredictAdjust\\": \\"超呼率\\",\\n \\"CreateTime\\": \\"2026-02-10 14:00:00\\",\\n \\"StartTime\\": \\"2026-02-10 15:00:00\\",\\n \\"AutoStop\\": \\"0\\",\\n \\"Wrapup\\": \\"5\\",\\n \\"MaxWaitTime\\": \\"10\\",\\n \\"Type\\": \\"2\\",\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"IsRandom\\": \\"0\\",\\n \\"AutoStopTime\\": \\"17:00:00\\",\\n \\"Id\\": \\"123\\",\\n \\"IvrId\\": \\"133\\",\\n \\"Quotiety\\": \\"0.33\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudWebcall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002', 'title' => ''], + ], + [ + 'name' => 'Tel', + 'in' => 'query', + 'schema' => ['description' => 'The phone number. For landlines, include the area code. For mobile numbers, do not add the `0` prefix. For landlines with an extension, use a hyphen (-) as a separator. You can specify multiple numbers separated by commas (,). The system calls each number in sequence. If a call is answered, the system stops calling the remaining numbers. For an [encrypted outbound call](../%E5%AD%97%E6%AE%B5%E5%AE%9A%E4%B9%89/%E6%8E%A5%E5%8F%A3%E9%83%A8%E5%88%86/%E5%8A%A0%E5%AF%86%E5%A4%96%E5%91%BC%E5%8F%B7%E7%A0%81%E5%8A%A0%E5%AF%86%E8%A7%84%E5%88%99.md), you must URL-encode the phone numbers.', 'type' => 'string', 'required' => true, 'example' => '13312345678', 'title' => ''], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['description' => 'A unique request ID, up to 300 bytes long. The system saves this ID to the `requestUniqueId` field in the call record, which you can use for later queries. All calls from a single API request share the same `requestUniqueId`.', 'type' => 'string', 'required' => false, 'example' => 'requset12345', 'title' => ''], + ], + [ + 'name' => 'UserField', + 'in' => 'query', + 'schema' => ['description' => 'A user-defined field, up to 250 bytes long. This value is saved to the `userField` in the call record for later queries. This parameter only takes effect if `paramNames` is set.', 'type' => 'string', 'required' => false, 'example' => 'UserField', 'title' => ''], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout for the customer call, in seconds. The value must be between 0 and 60, inclusive. The default is 30.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'Amd', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable answering machine detection (AMD). Valid values: `1` (enable) and `0` (disable). The default is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Delay', + 'in' => 'query', + 'schema' => ['description' => 'The call initiation delay, in seconds. The value must be between 0 and 60, inclusive. The default is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'MultiTelDelay', + 'in' => 'query', + 'schema' => ['description' => 'The delay, in seconds, between call attempts when `Tel` contains multiple numbers. The maximum value is 120. The default is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'MultiTelPush', + 'in' => 'query', + 'schema' => ['description' => 'When calling multiple numbers, this parameter specifies whether to send a hang-up notification for each call attempt. Valid values: `0` (sends one notification for the entire process) and `1` (sends a notification for each attempt). The default is `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID to display to the recipient. You can use an enterprise trunk number or a pre-configured caller ID.', 'type' => 'string', 'required' => false, 'example' => '41008502', 'title' => ''], + ], + [ + 'name' => 'ClidGroup', + 'in' => 'query', + 'schema' => ['description' => 'To use this parameter, your account must support identifier-based routing. This parameter has a lower priority than `Clid`.', 'type' => 'string', 'required' => false, 'example' => 'clidGroup', 'title' => ''], + ], + [ + 'name' => 'ClidList', + 'in' => 'query', + 'schema' => ['description' => 'Specifies a set of caller IDs for the outbound call. The system selects an available number from this set based on the number scheduling policy.', 'type' => 'string', 'required' => false, 'example' => '41008502', 'title' => ''], + ], + [ + 'name' => 'ClidAreaCode', + 'in' => 'query', + 'schema' => ['description' => 'A caller ID from a specific region. This parameter has a lower priority than `Clid`.', 'type' => 'string', 'required' => false, 'example' => '010', 'title' => ''], + ], + [ + 'name' => 'IvrId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the IVR flow to enter after the call connects. If you do not specify this parameter, the system uses the IVR flow configured in the console.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70', 'title' => ''], + ], + [ + 'name' => 'CrnId', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID navigation identifier.', 'type' => 'string', 'required' => false, 'example' => '33', 'title' => ''], + ], + [ + 'name' => 'Vid', + 'in' => 'query', + 'schema' => ['description' => 'The language of the IVR prompt. Valid values: `1` (Mandarin), `2` (Cantonese), `4` (Biaobei TTS), and `5` (Mandarin - sweet female voice). The default value is `1`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Retry', + 'in' => 'query', + 'schema' => ['description' => 'The number of retries. The maximum value is 5. To use this parameter, you must enable the webcall auto-retry feature for your enterprise account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'RetryInterval', + 'in' => 'query', + 'schema' => ['description' => 'The retry interval, in minutes. The value must be between 0 and 59, inclusive.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'ExpirTime', + 'in' => 'query', + 'schema' => ['description' => 'The request\'s expiration time, accurate to the second. Format: `YYYY-MM-DD HH:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloudWebcall', + 'summary' => 'This API operation lets a third-party platform send a call request to a hosted call center. The system calls the customer, then an agent, and connects them.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CreateCallTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => '语音通知', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the task template. Valid values:'."\n" + ."\n" + .'* **VMS_VOICE_TTS**: the text-to-speech (TTS) notification template.'."\n" + .'* **VMS_VOICE_CODE**: the voice notification template.'."\n" + .'* **VMS_TTS**: the voice verification code template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VMS_VOICE_CODE', 'title' => ''], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => ['description' => 'The template ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TTS_2122****', 'title' => ''], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['description' => 'The template name.'."\n", 'type' => 'string', 'required' => false, 'example' => '语音通知模板', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the calling number. Set the value to **LIST**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'LIST', 'default' => 'LIST', 'title' => ''], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['description' => 'The calling number. Only virtual numbers are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '05516214****', 'title' => ''], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => ['description' => 'The type of called numbers. Valid values:'."\n" + ."\n" + .'* **LIST**: the called numbers that are separated by commas (,).'."\n" + .'* **JSON**: a JSON-formatted list of called numbers with template parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'JSON', 'title' => ''], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => ['description' => 'The called numbers.'."\n" + ."\n" + .'* If you set DataType to LIST, the value of Data is in the LIST format.'."\n" + .'* If you set DataType to JSON, the value of Data is in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "paramNames":["name",,"key"], "calleeList":[ { "callee":"1310000****", "params":["张三","淘宝订单"] }, { "callee":"1320000****", "params":["李四","天猫订单"] } ] }', 'title' => ''], + ], + [ + 'name' => 'FireTime', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is unavailable.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StopTime', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is unavailable.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ScheduleType', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is unavailable.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '18390**', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ED815433-724A-4357-9991-A54AD2FF09FD', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"ED815433-724A-4357-9991-A54AD2FF09FD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 123456\\n ED815433-724A-4357-9991-A54AD2FF09FD\\n","errorExample":""}]', + 'title' => 'CreateCallTask', + 'summary' => '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.', + 'description' => 'You can create up to 1,000 voice notifications for each task.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-02-16T06:51:00.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The task name. The task name can be up to 30 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '任务测试', 'title' => ''], + ], + [ + 'name' => 'DialogId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the robot or communication script that is used to initiate the call.'."\n" + ."\n" + .'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.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000023****', 'title' => ''], + ], + [ + 'name' => 'CorpName', + 'in' => 'query', + 'schema' => ['description' => 'The company name, which must be the same as the **enterprise name** on the qualification management page.'."\n", 'type' => 'string', 'required' => false, 'example' => '阿里巴巴通信技术（北京）有限公司', 'title' => ''], + ], + [ + 'name' => 'Caller', + 'in' => 'query', + 'schema' => ['description' => 'The calling number.'."\n" + ."\n" + .'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.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571****5678', 'title' => ''], + ], + [ + 'name' => 'NumberStatusIdent', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable number status identification. Valid values:'."\n" + ."\n" + .'* **false** (default)'."\n" + .'* **true**'."\n" + ."\n" + .'> If you set this parameter to **true**, the reason why a call is not answered is recorded.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'RetryType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable auto-redial. Valid values:'."\n" + ."\n" + .'* **1**: enables auto-redial.'."\n" + .'* **0**: disables auto-redial.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'RecallStateCodes', + 'in' => 'query', + 'schema' => ['description' => 'The call state in which redial is required. Separate multiple call states with commas (,). Valid values:'."\n" + ."\n" + .'* **200010**: The phone of the called party is powered off.'."\n" + .'* **200011**: The number of the called party is out of service.'."\n" + .'* **200002**: The line is busy.'."\n" + .'* **200012**: The call is lost.'."\n" + .'* **200005**: The called party cannot be connected.'."\n" + .'* **200003**: The called party does not respond to the call.'."\n", 'type' => 'string', 'required' => false, 'example' => '200010,200011', 'title' => ''], + ], + [ + 'name' => 'RecallTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of redial times.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'RecallInterval', + 'in' => 'query', + 'schema' => ['description' => 'The redial interval. Unit: minutes. The value must be greater than 1.'."\n" + ."\n" + .'> The maximum redial interval is 30 minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'IsSelfLine', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to call the self-managed line. Valid values:'."\n" + ."\n" + .'* **false** (default)'."\n" + .'* **true**'."\n" + ."\n" + .'> If you set this parameter to **true**, calling numbers are not verified.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The unique ID of the robocall task.'."\n" + ."\n" + .'You can call the [QueryRobotTaskDetail](~~393538~~) operation to query the details of the task based on the task ID.'."\n", 'type' => 'string', 'example' => '400111****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"400111****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', + 'title' => 'CreateRobotTask', + 'summary' => 'Initiates an outbound robocall task.', + 'description' => 'You can call this operation to initiate an outbound robocall task by using the robot communication scripts preset in the Voice Messaging Service console. 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.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DegradeVideoFile' => [ + 'summary' => 'Degrades a video call to a voice call.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '217975', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'Call ID. Get the CallId from the return parameters of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) interface.', 'type' => 'string', 'required' => false, 'example' => '116012354148^1028137841****', 'title' => ''], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => 'Media type. The value is fixed as video.', 'type' => 'string', 'required' => false, 'example' => 'video', 'default' => 'AUDIO', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'ID reserved for the caller. The system returns this ID in the receipt message.'."\n" + ."\n" + .'This is a string with a length of 1 to 15 bytes.', 'type' => 'string', 'required' => false, 'example' => '225869*****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number that receives the voice call.', 'type' => 'string', 'required' => true, 'example' => '159****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Access denied details.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'Request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Video Downgrade ', + 'description' => 'The 5G video call feature is currently available by invitation only. Contact your operations manager to enable it.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DegradeVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:DegradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\t4001112222\\n","errorExample":""}]', + 'title' => 'DeleteRobotTask', + 'summary' => 'Deletes a robocall task.', + 'description' => 'You can call this operation to delete only tasks that are not started, that are completed, and that are terminated.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dyvms:DeleteRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ExecuteCallTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '77094', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID. You can call the [CreateCallTask](~~CreateCallTask~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2256****', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The task state. Valid values:'."\n" + ."\n" + .'* **RUNNING**'."\n" + .'* **STOP**'."\n" + .'* **CANCEL**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RUNNING', 'title' => ''], + ], + [ + 'name' => 'FireTime', + 'in' => 'query', + 'schema' => ['description' => 'The time when the call task is executed, in the yyyy-MM-dd HH:mm:ss format.'."\n" + ."\n" + .'> You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-03-09 00:00:00', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n 53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\n","errorExample":""}]', + 'title' => 'ExecuteCallTask', + 'summary' => 'Executes a call task.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteCallTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:ExecuteCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetCallMediaType' => [ + 'summary' => 'You can obtain the call type during a call.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'Call ID. You can get this value from the response of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) operation.', 'type' => 'string', 'required' => false, 'example' => '116012854210^10281427****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'Mobile phone number used in the call.', 'type' => 'string', 'required' => true, 'example' => '1580000****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Detailed reason for access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Data' => ['description' => 'MediaType: Media type of the call.'."\n" + ."\n" + .'- audio'."\n" + ."\n" + .'- video'."\n" + ."\n" + .'- Null (media type is undetermined during switching)', 'type' => 'object', 'example' => 'video', 'title' => ''], + 'Code' => ['description' => 'HTTP status code.'."\n" + ."\n" + .'- OK means the request succeeded.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The call succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Call Type ', + 'description' => 'The 5G video calling feature is currently in invitation-only beta. Contact your account manager to enable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallMediaType'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'GetHotlineQualificationByOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '52683', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => ['description' => 'The ticket ID.'."\n" + ."\n" + .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Qualification\\&Communication Script Management** > **Qualification Management**, and then click the **400 Qualifications** tab to view the ticket ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '153345012****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The qualification state. Valid values:'."\n" + ."\n" + .'* **NORMAL**'."\n" + .'* **OTHER**'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'QualificationId' => ['description' => 'The qualification ID.'."\n", 'type' => 'string', 'example' => '10000008748****', 'title' => ''], + 'OrderId' => ['description' => 'The ID of the qualification application ticket.'."\n", 'type' => 'string', 'example' => '15334****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"QualificationId\\": \\"10000008748****\\",\\n \\"OrderId\\": \\"15334****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n 6086693B-2250-17CE-A41F-06259AB6DB1B\\n \\n NORMA\\n 1478*****\\n 22456****\\n \\n","errorExample":""}]', + 'title' => 'GetHotlineQualificationByOrder', + 'summary' => 'Obtains the qualification ID based on the ID of a qualification application ticket.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'changeSet' => [ + ['createdAt' => '2021-12-28T01:51:14.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineQualificationByOrder'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetHotlineQualificationByOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetTemporaryFileUrl' => [ + 'summary' => 'Obtains a temporary URL for a video or audio file to allow immediate viewing.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the audio or video file.'."\n" + ."\n" + .'You can find this ID on the [Voice Files](https://dyvms.console.aliyun.com/files/list/voiceFiles) or [Video Files](https://dyvms.console.aliyun.com/videoFiles/list/slot) page in the Voice Service console.', 'type' => 'string', 'required' => true, 'example' => '45a04670582571eebf9e4531948c****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Detailed information about why access was denied.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A****', 'title' => ''], + 'Data' => ['description' => '- videoFileUrl: The URL to play the file.'."\n" + ."\n" + .'- videoFile: The audio or video file.'."\n" + ."\n" + .'- fileExpireTime: The time-to-live (TTL) of the file, in milliseconds.', 'type' => 'object', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The HTTP status code for the request.'."\n" + ."\n" + .'- OK means the request succeeded.'."\n" + ."\n" + .'- For other codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- **true**: The call succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A****\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain a Temporary File URL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemporaryFileUrl'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'GetToken' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '52685', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => ['description' => 'The token type.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dyvms', 'minLength' => 0, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Token' => ['description' => 'The token.'."\n", 'type' => 'string', 'example' => 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Token\\": \\"eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\nD9CB3933-9FE3-4870-BA8E-2BEE91B69DDD\\neyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZiI6MTYyMzM5NDQ2Ny****\\nOK\\ntrue\\n","errorExample":""}]', + 'title' => 'GetToken', + 'summary' => 'Obtains the token for authentication.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to five times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-03-01T02:04:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetToken'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'IvrCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52686', + 'abilityTreeNodes' => ['FEATUREdyvms4MLIJE'], + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => 'The calling number.'."\n" + ."\n" + .'The value must be a number you purchased. Each request supports only one calling number. In most cases, a calling number is configured with the maximum number of concurrent requests. New requests fail if the maximum number of concurrent requests is reached. 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 number you purchased.'."\n", 'type' => 'string', 'required' => true, 'example' => '0571****5678', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The called number.'."\n" + ."\n" + .'Only phone numbers in the Chinese mainland are supported. Each request supports only one called number.'."\n", 'type' => 'string', 'required' => true, 'example' => '1590****000', 'title' => ''], + ], + [ + 'name' => 'StartCode', + 'in' => 'query', + 'schema' => ['description' => 'The voice that is played when the call begins.'."\n" + ."\n" + .'* If you use a voice notification file, this parameter specifies the voice ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > Voice Notifications, and then click the **Voice Notification Files** tab to view the voice ID.'."\n" + .'* If you use a text-to-speech (TTS) template, this parameter specifies the template ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **TTS Template** tab to view the template ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TTS_1234****', 'title' => ''], + ], + [ + 'name' => 'StartTtsParams', + 'in' => 'query', + 'schema' => ['description' => 'The variables in the TTS template, in the JSON format.'."\n" + ."\n" + .'> This parameter is required when the StartCode parameter is set to the ID of a TTS template that contains variables.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"name":"xxx","code":"123"}', 'title' => ''], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of replay times. Valid values: 1 to 3.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'ByeCode', + 'in' => 'query', + 'schema' => ['description' => 'The end voice.'."\n" + ."\n" + .'* If you use a voice notification file, this parameter specifies the voice ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **Voice Notification Files** tab to view the voice ID.'."\n" + .'* If you use a TTS template, this parameter specifies the template ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **TTS Template** tab to view the template ID.'."\n" + ."\n" + .'> The value of the ByeCode parameter must be of the same type as the value of the StartCode parameter. This means that both parameters must specify voice IDs or TTS template IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TTS_1234****', 'title' => ''], + ], + [ + 'name' => 'ByeTtsParams', + 'in' => 'query', + 'schema' => ['description' => 'The variables in the TTS template, in the JSON format.'."\n" + ."\n" + .'> This parameter is required when the ByeCode parameter is set to the ID of a TTS template that contains variables.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"name":"xxx","code":"123"} ', 'title' => ''], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period for the subscriber to press a key. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'The ID that is reserved for the caller of the operation. This ID is returned to the caller in a receipt message.'."\n" + ."\n" + .'The value is of the STRING type and must be 1 to 15 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PR0210428****', 'title' => ''], + ], + [ + 'name' => 'MenuKeyMap', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the key pressed by the subscriber.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key that can be pressed by the subscriber.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'TtsParams' => ['description' => 'The variables in the TTS template, in the JSON format.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter specifies the substitution relationship of the variables in the TTS template if the value of the **MenuKeyMap.N.Code** parameter is set to the ID of the TTS template.'."\n" + ."\n" + .'* This parameter is required if the value of the **MenuKeyMap.N.Code** parameter is set to the ID of a TTS template that contains variables.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"name":"xxx","code":"123"}', 'title' => ''], + 'Code' => ['description' => 'The voice that corresponds to the key specified by the **MenuKeyMap.N.Key** parameter.'."\n" + ."\n" + .'* If you use a voice notification file, this parameter specifies the voice ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **Voice Notification Files** tab to view the voice ID.'."\n" + .'* If you use a TTS template, this parameter specifies the template ID. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications**, and then click the **TTS Template** tab to view the template ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TTS_1235****', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 15, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'CallId' => ['description' => 'The unique receipt ID of the call.'."\n" + ."\n" + .'You can call the [QueryCallDetailByCallId](~~393529~~) operation to query the details of the call based on the receipt ID.'."\n", 'type' => 'string', 'example' => '116012354148^10281378****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', + 'title' => 'IvrCall', + 'summary' => 'Initiates an interactive voice response (IVR) call to a specified number.', + 'description' => '* Your enterprise qualification is approved. For more information, see [Submit enterprise qualifications](~~149795~~).'."\n" + .'* Voice numbers are purchased. For more information, see [Purchase numbers](~~149794~~).'."\n" + .'* When the subscriber answers the call, the subscriber hears a voice that instructs the subscriber to press a key as needed. If the [message receipt](~~112503~~) feature is enabled, the Voice Messaging Service (VMS) platform returns the information about the key pressed by the subscriber to the business system. The key information includes the order confirmation, questionnaire survey, and satisfaction survey completed by the subscriber.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-15T01:57:46.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IvrCall'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:IvrCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListCallTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['description' => 'The template name.'."\n", 'type' => 'string', 'required' => false, 'example' => '身份验证', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The task state. Valid values:'."\n" + ."\n" + .'* **INIT**: The task is in the initial state.'."\n" + .'* **RELEASE**: The task is being parsed.'."\n" + .'* **RUNNING**: The task is running.'."\n" + .'* **STOP**: The task is suspended.'."\n" + .'* **SYSTEM_STOP**: The task is suspended by the system.'."\n" + .'* **CANCEL**: The task is canceled.'."\n" + .'* **SYSTEM_CANCEL**: The task is canceled by the system.'."\n" + .'* **DONE**: The task is complete.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INIT', 'title' => ''], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => '验证码', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '18908**', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the task template. Valid values:'."\n" + ."\n" + .'* **VMS_VOICE_TTS**: the text-to-speech (TTS) notification template.'."\n" + .'* **VMS_VOICE_CODE**: the voice notification template.'."\n" + .'* **VMS_TTS**: the voice verification code template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VMS_TTS', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5B0F201F-DCDA-45C2-AA92-1AE177F94991', 'title' => ''], + 'Total' => ['description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Data' => [ + 'description' => 'The task information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Task Information', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The task state. Valid values:'."\n" + ."\n" + .'* **INIT**: The task was in the initial state.'."\n" + .'* **RELEASE**: The task was being parsed.'."\n" + .'* **RUNNING**: The task was running.'."\n" + .'* **STOP**: The task was manually suspended.'."\n" + .'* **SYSTEM_STOP**: The task was suspended by the system.'."\n" + .'* **CANCEL**: The task was manually canceled.'."\n" + .'* **SYSTEM_CANCEL**: The task was canceled by the system.'."\n" + .'* **DONE**: The task was complete.'."\n", 'type' => 'string', 'example' => 'INIT'."\n", 'title' => ''], + 'Data' => ['description' => 'This parameter is unavailable.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'DataType' => ['description' => 'The type of the called number.'."\n", 'type' => 'string', 'example' => 'LIST', 'title' => ''], + 'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => '验证码', 'title' => ''], + 'CompletedCount' => ['description' => 'The number of tasks that were complete.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of called numbers.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'TemplateName' => ['description' => 'The template name.'."\n", 'type' => 'string', 'example' => '身份验证', 'title' => ''], + 'StopTime' => ['description' => 'This parameter is unavailable.'."\n", 'type' => 'string', 'example' => '1614332378000', 'title' => ''], + 'BizType' => ['description' => 'The type of the task template. Valid values:'."\n" + ."\n" + .'* **VMS_VOICE_TTS**: the TTS notification template.'."\n" + .'* **VMS_VOICE_CODE**: the voice notification template.'."\n" + .'* **VMS_TTS**: the voice verification code template.'."\n", 'type' => 'string', 'example' => 'VMS_TTS', 'title' => ''], + 'Resource' => ['description' => 'The calling number.'."\n", 'type' => 'string', 'example' => '0571000****', 'title' => ''], + 'TemplateCode' => ['description' => 'The ID of the voice template.'."\n", 'type' => 'string', 'example' => 'TTS_28292****', 'title' => ''], + 'FireTime' => ['description' => 'The time when the scheduled task was started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'string', 'example' => '1614330978000', 'title' => ''], + 'CompleteTime' => ['description' => 'The time when the task was completed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'string', 'example' => '1614330986000', 'title' => ''], + 'CompletedRate' => ['description' => 'The task progress.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '26%', 'title' => ''], + 'Id' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605***', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"5B0F201F-DCDA-45C2-AA92-1AE177F94991\\",\\n \\"Total\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"INIT\\\\n\\",\\n \\"Data\\": \\"1\\",\\n \\"DataType\\": \\"LIST\\",\\n \\"TaskName\\": \\"验证码\\",\\n \\"CompletedCount\\": 2,\\n \\"TotalCount\\": 6,\\n \\"TemplateName\\": \\"身份验证\\",\\n \\"StopTime\\": \\"1614332378000\\",\\n \\"BizType\\": \\"VMS_TTS\\",\\n \\"Resource\\": \\"0571000****\\",\\n \\"TemplateCode\\": \\"TTS_28292****\\",\\n \\"FireTime\\": \\"1614330978000\\",\\n \\"CompleteTime\\": \\"1614330986000\\",\\n \\"CompletedRate\\": 0,\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListCallTask', + 'summary' => '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.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-02-16T06:51:00.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListCallTaskDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '18908**', 'title' => ''], + ], + [ + 'name' => 'CalledNum', + 'in' => 'query', + 'schema' => ['description' => 'The called number.'."\n", 'type' => 'string', 'required' => false, 'example' => '1390000****', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The task state. Valid values:'."\n" + ."\n" + .'* **SUCCESS**: The task is successful.'."\n" + .'* **FAIL**: The task fails.'."\n" + .'* **INIT**: The task is not started.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SUCCESS', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D692AC3D-CBA8-417F-BEB9-5B73718922D4', 'title' => ''], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of called numbers.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The task state. Valid values:'."\n" + ."\n" + .'* **SUCCESS**: The task was successful.'."\n" + .'* **FAIL**: The task failed.'."\n" + .'* **INIT**: The task was not started.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Duration' => ['description' => 'The call duration. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'CalledNum' => ['description' => 'The called number.'."\n", 'type' => 'string', 'example' => '1390000****', 'title' => ''], + 'Caller' => ['description' => 'The calling number.'."\n", 'type' => 'string', 'example' => '0571000****', 'title' => ''], + 'Id' => ['description' => 'This parameter is unavailable.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '43085***', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D692AC3D-CBA8-417F-BEB9-5B73718922D4\\",\\n \\"Code\\": \\"OK\\",\\n \\"TotalPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Duration\\": 10,\\n \\"CalledNum\\": \\"1390000****\\",\\n \\"Caller\\": \\"0571000****\\",\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 7C943A5D-E12A-4184-A5F8-CF57B92815E3\\n 500\\n 2\\n 1\\n 1000\\n \\n FAIL\\n 05516214****\\n 0\\n 1300001****\\n \\n \\n FAIL\\n 05516214****\\n 0\\n 1310000****\\n \\n OK\\n","errorExample":""}]', + 'title' => 'ListCallTaskDetail', + 'summary' => 'Queries the details of call tasks based on task IDs after call tasks are complete.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTaskDetail'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListHotlineTransferRegisterFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '52690', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => ['description' => 'The qualification ID. You can call the [GetHotlineQualificationByOrder](~~393548~~) operation to obtain the qualification ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000****', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'HotlineNumber', + 'in' => 'query', + 'schema' => ['description' => 'The China 400 number.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNo' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Values' => [ + 'description' => 'The registration file.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MngOpMail' => ['description' => 'The email address of the handler.'."\n", 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'MngOpName' => ['description' => 'The name of the handler.'."\n", 'type' => 'string', 'example' => 'A***', 'title' => ''], + 'CorpName' => ['description' => 'The enterprise name.'."\n", 'type' => 'string', 'example' => 'A**', 'title' => ''], + 'Agree' => ['description' => 'The authenticity of the commitment.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'MngOpMobile' => ['description' => 'The mobile phone number of the handler.'."\n", 'type' => 'string', 'example' => '150****0000', 'title' => ''], + 'MngOpIdentityCard' => ['description' => 'The ID card number of the handler.'."\n", 'type' => 'string', 'example' => '5****************9', 'title' => ''], + 'HotlineNumber' => ['description' => 'The China 400 number.'."\n", 'type' => 'string', 'example' => '400903****', 'title' => ''], + 'QualificationId' => ['description' => 'The qualification ID.'."\n", 'type' => 'string', 'example' => '10000004933****', 'title' => ''], + 'ResUniqueCode' => ['description' => 'The unique code of the query operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"Values\\": [\\n {\\n \\"MngOpMail\\": \\"username@example.com\\",\\n \\"MngOpName\\": \\"A***\\",\\n \\"CorpName\\": \\"A**\\",\\n \\"Agree\\": \\"true\\",\\n \\"MngOpMobile\\": \\"150****0000\\",\\n \\"MngOpIdentityCard\\": \\"5****************9\\",\\n \\"HotlineNumber\\": \\"400903****\\",\\n \\"QualificationId\\": \\"10000004933****\\",\\n \\"ResUniqueCode\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListHotlineTransferRegisterFile', + 'summary' => 'Queries the registration information about a China 400 number.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotlineTransferRegisterFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:ListHotlineTransferRegisterFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListServiceInstanceForPage' => [ + 'summary' => 'Retrieves a paginated list of service instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => ['description' => 'The service instance number.', 'type' => 'string', 'required' => false, 'example' => '0571****1234', 'title' => ''], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '56', 'title' => ''], + ], + [ + 'name' => 'UsageId', + 'in' => 'query', + 'schema' => ['description' => 'The usage ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89', 'title' => ''], + ], + [ + 'name' => 'RelationNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the associated entity.', 'type' => 'string', 'required' => false, 'example' => '131****1111', 'title' => ''], + ], + [ + 'name' => 'Pager', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The paging information.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page. The default value is 10. The maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'PageIndex' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This field is returned only when the Resource Access Management (RAM) verification fails.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '每页最大100条！', 'title' => ''], + 'Model' => [ + 'title' => '', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '36', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '76', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '59', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '47', 'title' => ''], + 'Records' => [ + 'title' => '', + 'description' => 'The list of returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data object.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The binding status. Valid values: \\`Attached\\` and \\`Unattached\\`.', 'type' => 'string', 'example' => '绑定', 'title' => ''], + 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '29', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the instance was created. This is a UNIX timestamp.', 'type' => 'string', 'example' => '1759109856000', 'title' => ''], + 'SceneName' => ['description' => 'The name of the scenario.', 'type' => 'string', 'example' => '系统通知', 'title' => ''], + 'InstanceStatus' => ['description' => 'The instance status. Valid values: \\`init\\` (initialization), \\`usable\\` (active), \\`unusable\\` (inactive), and \\`destory\\` (unregistered).', 'type' => 'string', 'example' => 'init', 'title' => ''], + 'RelationTotalCount' => ['description' => 'The total number of associated entities.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], + 'UsageId' => ['description' => 'The usage ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], + 'Code' => ['description' => 'The service instance number.', 'type' => 'string', 'example' => '0571****1234', 'title' => ''], + 'RelationAvailableCount' => ['description' => 'The number of available associated entities.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'AliUid' => ['title' => 'aliUid', 'description' => 'The ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '11******123'], + 'Name' => ['description' => 'The service instance name.', 'type' => 'string', 'example' => '测试数据', 'title' => ''], + 'UsageName' => ['description' => 'The name of the usage.', 'type' => 'string', 'example' => '语音通知', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => ['description' => 'The status code. \\`OK\\` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"每页最大100条！\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 36,\\n \\"TotalPage\\": 76,\\n \\"PageSize\\": 59,\\n \\"PageNo\\": 47,\\n \\"Records\\": [\\n {\\n \\"Status\\": \\"绑定\\",\\n \\"SceneId\\": 29,\\n \\"GmtCreate\\": \\"1759109856000\\",\\n \\"SceneName\\": \\"系统通知\\",\\n \\"InstanceStatus\\": \\"init\\",\\n \\"RelationTotalCount\\": 33,\\n \\"UsageId\\": 96,\\n \\"Code\\": \\"0571****1234\\",\\n \\"RelationAvailableCount\\": 30,\\n \\"AliUid\\": 0,\\n \\"Name\\": \\"测试数据\\",\\n \\"UsageName\\": \\"语音通知\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Paged query of service instance list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'PauseVideoFile' => [ + 'summary' => 'Pauses the playback of a video file during a voice call.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201533', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The call ID. Get the CallId from the return parameters of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) interface.', 'type' => 'string', 'required' => false, 'example' => '116012854210^10281427****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number for which to pause video playback.', 'type' => 'string', 'required' => true, 'example' => '159****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Access denied details.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Data' => ['description' => 'Details of the returned result.', 'type' => 'object', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'Request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Values:'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Pause Video', + 'description' => 'The 5G video call feature is available by invitation only. Contact your operations manager to enable it.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PauseVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'PlayVideoFile' => [ + 'summary' => 'Play a video file during a voice call.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201522', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => ['description' => 'ID of the video file to play.'."\n" + ."\n" + .'You can find approved video IDs on the [Video Files](https://dyvms.console.aliyun.com/videoFiles/list/slot) page.', 'type' => 'string', 'required' => true, 'example' => '1120213841979436_20240620155*****5_.mp4', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'Mobile phone number that receives the video playback.', 'type' => 'string', 'required' => false, 'example' => '159****0000', 'title' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'Call ID. You can get the CallId from the response of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) operation.'."\n" + ."\n" + .'> Use the CallId to call the [QueryVideoPlayProgress](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-queryvideoplayprogress?spm) operation and check the video playback progress.', 'type' => 'string', 'required' => false, 'example' => '116012354148^1028137841****', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'Custom ID passed by the caller. This ID returns to the caller in the callback message.'."\n" + ."\n" + .'String. Length: 1 to 15 characters.', 'type' => 'string', 'required' => false, 'example' => '342268*****', 'title' => ''], + ], + [ + 'name' => 'OnlyPhone', + 'in' => 'query', + 'schema' => ['description' => 'Play the video only on mobile devices. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Detailed information about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Model' => ['description' => 'Call type.'."\n" + ."\n" + .'- video'."\n" + ."\n" + .'- voice', 'type' => 'boolean', 'example' => 'video', 'title' => ''], + 'Code' => ['description' => 'Request status code.'."\n" + ."\n" + .'- OK means the request succeeded.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Insert Video', + 'description' => 'The 5G video calling feature is currently available by invitation only. Contact your account manager to enable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PlayVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PlayVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryCallDetailByCallId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '52694', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the call.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The CallId parameter is included in the response parameters of the outbound call operation that you call to initiate a call.'."\n" + ."\n" + .'* The date when the call specified by CallId is started must be the same as the date specified by QueryDate.'."\n" + ."\n" + .'* The value of CallId must match the value of ProdId.'."\n", 'type' => 'string', 'required' => true, 'example' => '116014888060^10281631****', 'title' => ''], + ], + [ + 'name' => 'ProdId', + 'in' => 'query', + 'schema' => ['description' => 'The service ID. Valid values:'."\n" + ."\n" + .'* **11000000300006**: voice notification. You can call the [SingleCallByVoice](https://help.aliyun.com/document_detail/393517.html) operation to send a voice notification of the voice notification file type to the specified number.'."\n" + .'* **11010000138001**: voice verification code. You can call the [SingleCallByTts](https://help.aliyun.com/document_detail/393519.html) operation to send a voice verification code or a text-to-speech (TTS) voice notification to the specified number.'."\n" + .'* **11000000300005**: IVR. You can call the [IvrCall](https://help.aliyun.com/document_detail/393521.html) operation to initiate an interactive voice call to the specified number.'."\n" + .'* **11000000300009**: Session Initiation Protocol (SIP) call.'."\n" + .'* **11030000180001**: intelligent outbound call.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11000000300006', 'title' => ''], + ], + [ + 'name' => 'QueryDate', + 'in' => 'query', + 'schema' => ['description' => 'The time at which call details are queried. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> The system queries the call records that are generated within 24 hours after the specified point in time. For example, if you specify the time 20:00:01 on November 21, 2022, the system queries the call records that are generated for the specified call ID from 20:00:01 on November 21, 2022, to 20:00:01 on November 22, 2022.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1669032001000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The details of the call, in the JSON format.'."\n" + ."\n" + .'* **caller**: the calling number.'."\n" + .'* **startDate**: the time when the call was started.'."\n" + .'* **stateDesc**: the description of the call state.'."\n" + .'* **duration**: the call duration. Unit: seconds. The value **0** indicates that the user was not connected.'."\n" + .'* **callerShowNumber**: the calling number displayed to the called party.'."\n" + .'* **gmtCreate**: the time when the call request was received.'."\n" + .'* **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](~~55085~~).'."\n" + .'* **endDate**: the time when the call was ended.'."\n" + .'* **calleeShowNumber**: the number displayed to the called party.'."\n" + .'* **callee**: the called number.'."\n" + .'* **aRingTime**: the time when Line A started to ring, in the yyyy-MM-dd HH:mm:ss format.'."\n" + .'* **aEndTime**: the time when ringing on Line A ended, in the yyyy-MM-dd HH:mm:ss format.'."\n" + .'* **bRingTime**: the time when Line B started to ring, in the yyyy-MM-dd HH:mm:ss format.'."\n" + .'* **bEndTime**: the time when ringing on Line B ended, in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', '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****"}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"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****\\\\\\"}\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n {\\"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****\\"}\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n","errorExample":""}]', + 'title' => 'QueryCallDetailByCallId', + 'summary' => 'Queries the call details based on a call ID, including the call start time, call duration, call status, call end time, and called number.', + 'description' => 'QueryCallDetailByCallId is a common query operation. You can call this operation to query the details of a voice notification, voice verification code, interactive voice response (IVR), intelligent inbound voice call, intelligent outbound voice call, or intelligent robocall.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByCallId'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByCallId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryCallDetailByTaskId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '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**.'."\n", 'type' => 'string', 'required' => true, 'example' => '4001112222', 'title' => ''], + ], + [ + 'name' => 'QueryDate', + 'in' => 'query', + 'schema' => ['description' => '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.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2020-10-09 09:02:03', 'title' => ''], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => 'The called number. You can view the outbound call records of only one called number.'."\n", 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The call details of the outbound robocall task, in the JSON format.'."\n" + ."\n" + .'* **startDate**: the time when the call was answered.'."\n" + ."\n" + .'* **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.'."\n" + ."\n" + .'* **statusCode**: the status code.'."\n" + ."\n" + .'* **EndDate**: the time when the call was ended.'."\n" + ."\n" + .'* **calleeShowNumber**: the calling number displayed to the called party.'."\n" + ."\n" + .'* **callee**: the called number.'."\n" + ."\n" + .'* **duration**: the billing duration.'."\n" + ."\n" + .'* **gmtCreate**: the time when the outbound robocall task was created.'."\n" + ."\n" + .'* **hangupDirection**: the party who hung up.'."\n" + ."\n" + .'* **tags**: the call tags.'."\n" + ."\n" + .'* **dialogCount**: the number of conversation rounds in the call.'."\n" + ."\n" + .'* **sureCount**: the number of times that the robocall task was acknowledged.'."\n" + ."\n" + .'* **denyCount**: the number of times that the robocall task was denied.'."\n" + ."\n" + .'* **rejectCount**: the number of times that the robocall task was rejected.'."\n" + ."\n" + .'* **customCount**: the number of times that the robocall task was customized.'."\n" + ."\n" + .'* **knowledgeCount**: the number of times that the knowledge base was queried.'."\n" + ."\n" + .'* **recordFile**: the download URL of the recording file. The URL is valid only for 48 hours. The recording file must be downloaded in time.'."\n" + ."\n" + .'* **callId**: the call ID.'."\n" + ."\n" + .'* **recordStatus**: indicates whether a recording file was available. Valid values:'."\n" + ."\n" + .' * 1: A recording file was available.'."\n" + .' * 2: No recording file was available.'."\n" + ."\n" + .'* **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.'."\n" + ."\n" + .'* **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.'."\n" + ."\n" + .'* **callee**: the called number.'."\n" + ."\n" + .'* **dialogDetail**: the conversation details. The value is a JSON array that contains the following parameters:'."\n" + ."\n" + .' * **role**: the role who spoke.'."\n" + .' * **content**: the content of the speech.'."\n" + .' * **time**: the start time of the speech.'."\n" + ."\n" + .'> The preceding parameters are for reference only. The actually returned parameters prevail.'."\n", 'type' => 'string', '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}'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D86B61A8-F2EE-4E4C-9F05-08A4676FFD89', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"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}\\\\n\\",\\n \\"RequestId\\": \\"D86B61A8-F2EE-4E4C-9F05-08A4676FFD89\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryCallDetailByTaskId', + 'summary' => 'Queries the call details of an outbound robocall task.', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByTaskId'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByTaskId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryCallInPoolTransferConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => ['description' => 'The China 400 number used to transfer the call.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400903****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => ['description' => 'The time when the call transfer task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1623137002000', 'title' => ''], + 'CalledRouteMode' => ['description' => 'The call mode. Valid values:'."\n" + ."\n" + .'* **roundRobin**'."\n" + .'* **random**'."\n", 'type' => 'string', 'example' => 'random', 'title' => ''], + 'TransferTimeout' => ['description' => 'The timeout period for transferring the call.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'Details' => [ + 'description' => 'The details of the response parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Called' => ['description' => 'The number used to transfer the call.'."\n", 'type' => 'string', 'example' => '400903****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Data\\": {\\n \\"GmtCreate\\": 1623137002000,\\n \\"CalledRouteMode\\": \\"random\\",\\n \\"TransferTimeout\\": \\"30\\",\\n \\"Details\\": [\\n {\\n \\"Called\\": \\"400903****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\n7BF47617-7851-48F7-A3A1-2021342A78E2\\n\\n 1623137002000\\n random\\n 30\\n
\\n 400****\\n
\\n\\nOK\\n","errorExample":""}]', + 'title' => 'QueryCallInPoolTransferConfig', + 'summary' => 'Queries the configuration of the phone number used to transfer a call.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInPoolTransferConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInPoolTransferConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryCallInTransferRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '52697', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => ['description' => 'The phone number to which a call is transferred.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400****', 'title' => ''], + ], + [ + 'name' => 'CallInCaller', + 'in' => 'query', + 'schema' => ['description' => 'The calling number of the inbound call.'."\n", 'type' => 'string', 'required' => false, 'example' => '150****0000', 'title' => ''], + ], + [ + 'name' => 'QueryDate', + 'in' => 'query', + 'schema' => ['description' => 'The time at which call transfer records are queried, in the YYYY-MM-DD hh:mm:ss format.'."\n" + ."\n" + .'> The query result is all the call transfer records of the specified day.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-28 00:00:00', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 10.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', 'title' => ''], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNo' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'Values' => [ + 'description' => 'The call transfer records.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallInCalled' => ['description' => 'The called number of the inbound call.'."\n", 'type' => 'string', 'example' => '150****0000', 'title' => ''], + 'TransferCalled' => ['description' => 'The phone number to which the call was transferred.'."\n", 'type' => 'string', 'example' => '151****0000', 'title' => ''], + 'RecordUrl' => ['description' => 'The recording URL.'."\n", 'type' => 'string', 'example' => 'http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684****.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73****&Signature=****mUqkPqIQ%3D', 'title' => ''], + 'TransferCaller' => ['description' => 'The calling number that transferred the call.'."\n", 'type' => 'string', 'example' => '151****0000', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the call was initiated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2020-10-03 10:21:21', 'title' => ''], + 'CallInCaller' => ['description' => 'The calling number of the inbound call.'."\n", 'type' => 'string', 'example' => '150****0000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 50,\\n \\"Values\\": [\\n {\\n \\"CallInCalled\\": \\"150****0000\\",\\n \\"TransferCalled\\": \\"151****0000\\",\\n \\"RecordUrl\\": \\"http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684****.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73****&Signature=****mUqkPqIQ%3D\\",\\n \\"TransferCaller\\": \\"151****0000\\",\\n \\"GmtCreate\\": 0,\\n \\"CallInCaller\\": \\"150****0000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\n7BF47617-7851-48F7-A3A1-2021342A78E2\\n\\n 20\\n 50\\n 1\\n \\n 1624865503000\\n 150****0000\\n http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684eea0.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73PsLI&Signature=****mUqkPqIQ%3D\\n 151****0000\\n 151****0000\\n 150****0000\\n \\n\\nOK\\n","errorExample":""}]', + 'title' => 'QueryCallInTransferRecord', + 'summary' => 'Queries call transfer records.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' 无', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInTransferRecord'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInTransferRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryRobotInfoList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => ['description' => 'The review state. Valid values:'."\n" + ."\n" + .'* **CONFIGURABLE**'."\n" + .'* **AUDITING**'."\n" + .'* **AUDITPASS**'."\n" + .'* **AUDITFAIL**'."\n", 'type' => 'string', 'required' => false, 'example' => 'AUDITING', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The basic information about the robot, in the JSON format. The basic information contains the following parameters:'."\n" + ."\n" + .'* **id**: the robot ID.'."\n" + .'* **robotName**: the robot name.'."\n" + .'* **robotType**: the robot type.'."\n" + .'* **auditStatus**: the review state.'."\n" + .'* **gmtCreate**: the time when the task was created.'."\n" + .'* **gmtModified**: the time when the task was modified.'."\n" + .'* **partnerId**: the partner ID.'."\n" + .'* **asrId**: the ID of the automatic speech recognition (ASR) model.'."\n" + .'* **asrType**: the ASR type. Valid values: **Public** and **Private**.'."\n" + .'* **remark**: the additional information.'."\n", 'type' => 'string', 'example' => '{["id":1000010920004, "gmtModified":"Thu Mar 21 15:38:55 CST 2019", "auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 12:00:51 CST 2019","remark":"测试勿删，测试请通过","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"催收场景5--ssml标记2-RVR-副本"},{"id":1000010920003,"gmtModified":"Thu Mar 21 11:51:10 CST 2019","auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 11:44:57 CST 2019","remark":"测试勿删，内部测试请通过","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"催收场景5-ssml标记2-RVR"]}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F59AF338-655D-48E8-9471-5EB07692B1CC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{[\\\\\\"id\\\\\\":1000010920004, \\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 15:38:55 CST 2019\\\\\\", \\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 12:00:51 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5--ssml标记2-RVR-副本\\\\\\"},{\\\\\\"id\\\\\\":1000010920003,\\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 11:51:10 CST 2019\\\\\\",\\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 11:44:57 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，内部测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5-ssml标记2-RVR\\\\\\"]}\\",\\n \\"RequestId\\": \\"F59AF338-655D-48E8-9471-5EB07692B1CC\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryRobotInfoList', + 'summary' => 'Queries a list of robots to obtain their details.', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotInfoList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryRobotTaskCallDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001', 'title' => ''], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => 'The called number.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '130****0000', 'title' => ''], + ], + [ + 'name' => 'QueryDate', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp of the time at which the call details you want to query.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603239801000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The call details of a robocall task, in the JSON format.'."\n" + ."\n" + .'* **taskId**: the unique ID of the robocall task.'."\n" + .'* **caller**: the calling number.'."\n" + .'* **called**: the called number.'."\n" + .'* **duration**: the call duration. Unit: seconds.'."\n" + .'* **label**: the label of the called party.'."\n" + .'* **dialogCount**: the number of conversation rounds in the call.'."\n" + .'* **callResult**: the call result.'."\n" + .'* **hangupDirection**: the party who hung up. Valid values: **0**: the robot. **1**: the called party.'."\n" + .'* **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 the agent. The value 0 indicates that the call failed to be transferred to the agent. The value 3 indicates that the call was not transferred to the agent.'."\n" + .'* **transferNumber**: the phone number of the agent to whom the call was transferred.'."\n" + .'* **transferFailReason**: the reason why the call failed to be transferred to the agent.'."\n" + .'* **callId**: the unique receipt ID of the call, in the `taskId^bizId` format.'."\n" + .'* **recallCurTimes**: the number of recalls.'."\n" + .'* **callStartTime**: the start time of the call.'."\n" + .'* **callEndTime**: the end time of the call.'."\n" + .'* **sureCount**: the number of times that the robocall task was affirmed.'."\n" + .'* **denyCount**: the number of times that the robocall task was denied.'."\n" + .'* **rejectCount**: the number of times that the robocall task was rejected.'."\n" + .'* **customCount**: the number of times that the robocall task was customized.'."\n" + .'* **knowledgeCount**: the number of times that the knowledge base was queried.'."\n" + .'* **defaultCount**: the default number of calls.'."\n" + .'* **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.'."\n" + .'* **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.'."\n" + .'* **recordStatus**: Indicates whether the call has a recording file. Valid values: **1**: The call has a recording file. **2**: The call does not have a recording file.'."\n" + .'* **recordFile**: the download URL of the recording file.'."\n" + .'* **dialogDetail**: the dialog details, in a JSON-formatted array. **role**: the object of the speech. **content**: the content of the speech. **speakTime**: the time of the speech.'."\n", 'type' => 'string', 'example' => '{ "taskId" : 1045001, "caller" : "0571-8899****", "called" : "130****0000", "duration" : "60", "label" : "邀约，有房，无车", "dialogCount": "3", "callResult" : "无法接通", "hangupDirection" : "1", "transferResult" : "3", "transferNumber" ：0571-8833****, "transferFailReason" ："用户挂断", "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, "recordStatus":1, "recordFile": "http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******", "dialogDetail": [{"role": "robot","speakTime": "2019-06-19 20:44:17","content":"开场白"}] }', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{ \\\\\\"taskId\\\\\\" : 1045001, \\\\\\"caller\\\\\\" : \\\\\\"0571-8899****\\\\\\", \\\\\\"called\\\\\\" : \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\" : \\\\\\"60\\\\\\", \\\\\\"label\\\\\\" : \\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\": \\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\" : \\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\" : \\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\" : \\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\" ：0571-8833****, \\\\\\"transferFailReason\\\\\\" ：\\\\\\"用户挂断\\\\\\", \\\\\\"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, \\\\\\"recordStatus\\\\\\":1, \\\\\\"recordFile\\\\\\": \\\\\\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******\\\\\\", \\\\\\"dialogDetail\\\\\\": [{\\\\\\"role\\\\\\": \\\\\\"robot\\\\\\",\\\\\\"speakTime\\\\\\": \\\\\\"2019-06-19 20:44:17\\\\\\",\\\\\\"content\\\\\\":\\\\\\"开场白\\\\\\"}] }\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryRobotTaskCallDetail', + 'summary' => 'Queries the call details of a called number.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallDetail'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryRobotTaskCallList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~393531~~) operation to obtain the task ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1045001****', 'title' => ''], + ], + [ + 'name' => 'DurationFrom', + 'in' => 'query', + 'schema' => ['description' => 'The minimum call duration.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'DurationTo', + 'in' => 'query', + 'schema' => ['description' => 'The maximum call duration.'."\n", 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'DialogCountFrom', + 'in' => 'query', + 'schema' => ['description' => 'The minimum number of conversation rounds in the call.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'DialogCountTo', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of conversation rounds in the call.'."\n", 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'HangupDirection', + 'in' => 'query', + 'schema' => ['description' => 'The party who hangs up. Valid values:'."\n" + ."\n" + .'* **0**: the called party.'."\n" + .'* **1**: the robot.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'CallResult', + 'in' => 'query', + 'schema' => ['description' => 'The call result. Valid values:'."\n" + ."\n" + .'* **200002**: The line is busy.'."\n" + .'* **200005**: The called party cannot be connected.'."\n" + .'* **200010**: The phone of the called party is powered off.'."\n" + .'* **200011**: The called party is out of service.'."\n" + .'* **200012**: The call is lost.'."\n", 'type' => 'string', 'required' => false, 'example' => '200002', 'title' => ''], + ], + [ + 'name' => 'Called', + 'in' => 'query', + 'schema' => ['description' => 'The called number.'."\n", 'type' => 'string', 'required' => false, 'example' => '1300****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The information about the robocall task, which is a JSON-formatted array.'."\n" + ."\n" + .'* **taskId**: the unique ID of the robocall task.'."\n" + .'* **caller**: the calling number.'."\n" + .'* **called**: the called number.'."\n" + .'* **duration**: the call duration. Unit: seconds.'."\n" + .'* **label**: the label of the called party.'."\n" + .'* **dialogCount**: the number of conversation rounds in the call.'."\n" + .'* **callResult**: the call result.'."\n" + .'* **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.'."\n" + .'* **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.'."\n" + .'* **transferNumber**: the phone number of the agent to whom the call was transferred.'."\n" + .'* **transferFailReason**: the reason why the call failed to be transferred to an agent.'."\n" + .'* **callId**: the unique receipt ID of the call.'."\n" + .'* **recallCurTimes**: the number of recalls.'."\n" + .'* **callStartTime**: the start time of the call.'."\n" + .'* **callEndTime**: the end time of the call.'."\n" + .'* **sureCount**: the number of times that the robocall task was acknowledged.'."\n" + .'* **denyCount**: the number of times that the robocall task was denied.'."\n" + .'* **rejectCount**: the number of times that the robocall task was rejected.'."\n" + .'* **customCount**: the number of times that the robocall task was customized.'."\n" + .'* **knowledgeCount**: the number of times that the knowledge base was queried.'."\n" + .'* **defaultCount**: the default number of calls.'."\n" + .'* **knowledgeBusinessCount**: the number of call failures caused by the business issues in the knowledge base.'."\n" + .'* **knowledgeCommonCount**: the number of call failures caused by the common issues in the knowledge base.'."\n" + .'* ****'."\n", 'type' => 'string', 'example' => '[ {"taskId":"1045001", "caller":"0571-889****", "called": "130****0000", "duration":"60", "label":"邀约，有房，无车", "dialogCount":"3", "callResult":"无法接通", "hangupDirection":"1", "transferResult":"3", "transferNumber":"0571-8833****", "transferFailReason":"用户挂断", "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"} ]', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"[ {\\\\\\"taskId\\\\\\":\\\\\\"1045001\\\\\\", \\\\\\"caller\\\\\\":\\\\\\"0571-889****\\\\\\", \\\\\\"called\\\\\\": \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\":\\\\\\"60\\\\\\", \\\\\\"label\\\\\\":\\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\":\\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\":\\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\":\\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\":\\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\":\\\\\\"0571-8833****\\\\\\", \\\\\\"transferFailReason\\\\\\":\\\\\\"用户挂断\\\\\\", \\\\\\"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\\\\\\"} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryRobotTaskCallList', + 'summary' => 'Queries the information about a robocall task.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryRobotTaskDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The details of the robocall task, in the JSON format.'."\n" + ."\n" + .'* **Id**: the unique ID of the robocall task.'."\n" + .'* **taskName**: the task name.'."\n" + .'* **robotId**: the robot ID.'."\n" + .'* **robotName**: the robot name.'."\n" + .'* **corpName**: the company name.'."\n" + .'* **caller**: the number displayed to the called party.'."\n" + .'* **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.'."\n" + .'* **status**: the task state. You can call the [QueryRobotTaskList](~~QueryRobotTaskList~~) operation to obtain the task state from the `status` parameter.'."\n" + .'* **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.'."\n" + .'* **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.'."\n" + .'* **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.'."\n" + .'* **recallTimes**: the number of redial times.'."\n" + .'* **recallInterval**: the redial interval. Unit: minutes.'."\n" + .'* **createTime**: the time when the task was created, in the yyyy-MM-dd HH:mm:ss format.'."\n" + .'* **fireTime**: the time when the task was started, in the yyyy-MM-dd HH:mm:ss format.'."\n" + .'* **completeTime**: the time when the task was completed, in the yyyy-MM-dd HH:mm:ss format.'."\n" + .'* **filename**: the name of the called number file.'."\n" + .'* **ossFilePath**: the path of the called number file.'."\n", 'type' => 'string', 'example' => '{"id":1045001,"taskName":"智能语音务","robotId":1000000075003,"robotName":"机器人","corpName":"xx公司 ","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"}]}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":1045001,\\\\\\"taskName\\\\\\":\\\\\\"智能语音务\\\\\\",\\\\\\"robotId\\\\\\":1000000075003,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"corpName\\\\\\":\\\\\\"xx公司 \\\\\\",\\\\\\"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\\\\\\"}]}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryRobotTaskDetail', + 'summary' => 'Queries the details of a robocall task.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskDetail'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryRobotTaskList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => '任务测试', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The task state. Valid values:'."\n" + ."\n" + .'* **INIT**: The task is not started.'."\n" + .'* **READY**: The task is ready to start.'."\n" + .'* **DISPATCH**: The task is being parsed.'."\n" + .'* **EXCUTING**: The task is being executed.'."\n" + .'* **MANUAL_STOP**: The task is manually suspended.'."\n" + .'* **SYSTEM_STOP**: The task is suspended by the system.'."\n" + .'* **ARREARS_STOP**: The task is suspended due to overdue payments.'."\n" + .'* **CANCEL**: The task is manually canceled.'."\n" + .'* **SYSTEM_CANCEL**: The task is canceled by the system.'."\n" + .'* **FINISH**: The task is complete.'."\n", 'type' => 'string', 'required' => false, 'example' => 'EXCUTING', 'title' => ''], + ], + [ + 'name' => 'Time', + 'in' => 'query', + 'schema' => ['description' => 'The date when the task is created, in the yyyy-MM-dd format.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-14', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The robocall tasks, in the JSON format.'."\n" + ."\n" + .'* **id**: the unique ID of the robocall task.'."\n" + .'* **taskName**: the task name.'."\n" + .'* **robotId**: the robot ID.'."\n" + .'* **robotName**: the robot name.'."\n" + .'* **status**: the task state.'."\n" + .'* **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.'."\n" + .'* **createTime**: the time when the task was created, in the yyyy.MM.dd HH:mm:ss format.'."\n" + .'* **completeTime**: the time when the task was completed, in the yyyy.MM.dd HH:mm:ss format.'."\n" + .'* **fireTime**: the time when the task was started, in the yyyy.MM.dd HH:mm:ss format.'."\n" + .'* **totalCount**: the total number of calls processed.'."\n" + .'* **finishCount**: the number of calls completed.'."\n", 'type' => 'string', 'example' => '[ {"id": 1045001, "taskName": "智能语音任务", "robotId": 1000000075003, "robotName": "机器人", "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} ]', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'PageNo' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of tasks.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[ {\\\\\\"id\\\\\\": 1045001, \\\\\\"taskName\\\\\\": \\\\\\"智能语音任务\\\\\\", \\\\\\"robotId\\\\\\": 1000000075003, \\\\\\"robotName\\\\\\": \\\\\\"机器人\\\\\\", \\\\\\"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} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"PageNo\\": \\"1\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryRobotTaskList', + 'summary' => 'Queries the information about all robocall tasks.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryRobotv2AllList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The information about the robot communication script, in the JSON format.'."\n" + ."\n" + .'* **id**: the ID of the robot communication script.'."\n" + .'* **robotName**: the name of the robot communication script.'."\n" + .'* **robotType**: the type of the robot communication script.'."\n", 'type' => 'string', 'example' => '{"id":100000007****,"robotName":"机器人","robotType":"CUSTOM"}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":100000007****,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\"}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryRobotv2AllList', + 'summary' => 'Queries a list of robot communication scripts.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotv2AllList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotv2AllList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryVideoPlayProgress' => [ + 'summary' => 'Queries the playback progress of a video file inserted into a voice call.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '217974', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The call ID. You can get the CallId from the response parameters of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) API.', 'type' => 'string', 'required' => false, 'example' => '116004767703^102806****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number for which you want to query video playback progress.', 'type' => 'string', 'required' => true, 'example' => '159****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about why access was denied.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'A message describing the result.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Data' => ['description' => 'Details of the response.'."\n" + ."\n" + .'- progress: The current playback duration, in milliseconds.'."\n" + ."\n" + .'- duration: The total duration of the file.'."\n" + ."\n" + .'> You can calculate the playback progress percentage by dividing progress by duration.', 'type' => 'object', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- OK indicates that the request succeeded.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- true: The call succeeded.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Video Progress ', + 'description' => 'The 5G video calling feature is currently available by invitation only. Contact your account manager to enable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVideoPlayProgress'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:QueryVideoPlayProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryVirtualNumberRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => ['description' => 'The service name. Default value: **dyvms**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dyvms', 'default' => 'dyvms', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20', 'title' => ''], + ], + [ + 'name' => 'RouteType', + 'in' => 'query', + 'schema' => ['description' => 'The route type. Valid values:'."\n" + ."\n" + .'**0**: number location first. **1**: random.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => ['description' => 'The qualification ID.'."\n" + ."\n" + .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Qualifications\\&Communication Scripts > Qualification Management**, and then click **Details** in the Actions column to view the qualification ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000542****', 'title' => ''], + ], + [ + 'name' => 'RegionNameCity', + 'in' => 'query', + 'schema' => ['description' => 'The city to which the virtual number belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => '浙江/杭州', 'title' => ''], + ], + [ + 'name' => 'SpecId', + 'in' => 'query', + 'schema' => ['description' => 'The number type. Valid values:'."\n" + ."\n" + .'* **1**: the number provided by a virtual network operator, in the 05710000\\*\\*\\*\\* format.'."\n" + .'* **2**: the number provided by an Internet service provider (ISP).'."\n" + .'* **3**: a 5-digit phone number that starts with 95.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'RelatedNum', + 'in' => 'query', + 'schema' => ['description' => 'The real number.'."\n", 'type' => 'string', 'required' => false, 'example' => '0213144****', 'title' => ''], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => ['description' => 'The virtual number.'."\n", 'type' => 'string', 'required' => false, 'example' => '05710000****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value 200 indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The list of associations between virtual numbers and real numbers. The following fields are returned:'."\n" + ."\n" + .'* **relatedNum**: the real number.'."\n" + .'* **createTime**: the time when the number was activated.'."\n" + .'* **pageNo**: the page number.'."\n" + .'* **pageSize**: the number of entries per page.'."\n" + .'* **total**: the total number of entries returned.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "data": ['."\n" + .' {'."\n" + .' "regionNameProvince": "湖南",'."\n" + .' "relatedNum": "0734284****",'."\n" + .' "specName": "联通全国",'."\n" + .' "createTime": "2021-07-02 16:04:49",'."\n" + .' "regionNameCity": "衡阳",'."\n" + .' "corpName": "阿里巴巴通信技术（北京）有限公司",'."\n" + .' "virtualNum": "05710000****"'."\n" + .' }'."\n" + .' ],'."\n" + .' "pageSize": 20,'."\n" + .' "total": 1,'."\n" + .' "pageNo": 1'."\n" + .'}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8FAD5988-B483-48A4-B251-6E8470A67371', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'VirtualNumber.NotOwn', 'errorMessage' => 'You can only use your own virtual number.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"regionNameProvince\\\\\\": \\\\\\"湖南\\\\\\",\\\\n \\\\\\"relatedNum\\\\\\": \\\\\\"0734284****\\\\\\",\\\\n \\\\\\"specName\\\\\\": \\\\\\"联通全国\\\\\\",\\\\n \\\\\\"createTime\\\\\\": \\\\\\"2021-07-02 16:04:49\\\\\\",\\\\n \\\\\\"regionNameCity\\\\\\": \\\\\\"衡阳\\\\\\",\\\\n \\\\\\"corpName\\\\\\": \\\\\\"阿里巴巴通信技术（北京）有限公司\\\\\\",\\\\n \\\\\\"virtualNum\\\\\\": \\\\\\"05710000****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"pageSize\\\\\\": 20,\\\\n \\\\\\"total\\\\\\": 1,\\\\n \\\\\\"pageNo\\\\\\": 1\\\\n}\\",\\n \\"RequestId\\": \\"8FAD5988-B483-48A4-B251-6E8470A67371\\"\\n}","errorExample":""},{"type":"xml","example":"\\n8FAD5988-B483-48A4-B251-6E8470A67371\\n\\n \\n 1705559****\\n 2021-03-26 12:34:08\\n \\n 20\\n 1\\n 1\\n\\n200\\n","errorExample":""}]', + 'title' => 'QueryVirtualNumberRelation', + 'summary' => '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.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 200 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-18T02:50:33.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-02-16T06:51:00.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVirtualNumberRelation'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryVmsRealNumberCallConnectionRateInfo' => [ + 'summary' => 'Queries the connection rate of real numbers.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'VirtualNumber', + 'in' => 'query', + 'schema' => ['description' => 'Virtual number', 'type' => 'string', 'required' => false, 'example' => '0571***1234', 'title' => ''], + ], + [ + 'name' => 'RealNumber', + 'in' => 'query', + 'schema' => ['description' => 'The actual phone number.', 'type' => 'string', 'required' => false, 'example' => '131***1234', 'title' => ''], + ], + [ + 'name' => 'TimePeriod', + 'in' => 'query', + 'schema' => ['description' => 'Time period (start millisecond timestamp - end millisecond timestamp)', 'type' => 'string', 'required' => false, 'example' => '1764666240123-1764686240567', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'This parameter group is deprecated. Ignore it.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '95B86652-B234-5387-BAC6-E441FR49399F'], + 'Message' => ['description' => 'The message indicating the request result.', 'type' => 'string', 'title' => '', 'example' => '参数缺失！'], + 'Model' => [ + 'title' => '', + 'description' => 'Request result data', + 'type' => 'object', + 'properties' => [ + 'RingingRate' => ['description' => 'Ringing rate', 'type' => 'number', 'format' => 'double', 'example' => '25.4222', 'title' => ''], + 'ResourceId' => ['description' => 'Deprecated parameter. Ignore it.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'RingingCount' => ['description' => 'Ringing count', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'ResourceType' => ['title' => 'EcsInstance, EcsDisk, EcsImage, EcsSnapshot, EcsSecurityGroup, EcsEip, EcsVpc, EcsVRouter, EcsVSwitch, EcsVRouteTable, EcsAuthImage, EcsAll, SlbLoadbalancer, SlbVm, RdsInstance, RdsAllInstance, KvsInstance, OcsInstance, OdpsInstance', 'description' => 'Deprecated parameter. Ignore it.', 'type' => 'string', 'example' => '无'], + 'RegionId' => ['description' => 'Deprecated parameter. Ignore it.', 'type' => 'string', 'title' => '', 'example' => '无'], + 'CallConnectionRate' => ['description' => 'Connection rate', 'type' => 'number', 'format' => 'double', 'example' => '6.71672', 'title' => ''], + 'RequestCount' => ['description' => 'Requested call count', 'type' => 'integer', 'format' => 'int64', 'example' => '49', 'title' => ''], + 'CompleteCount' => ['description' => 'Connected count', 'type' => 'integer', 'format' => 'int64', 'example' => '52', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['description' => 'Request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error codes](https://help.aliyun.com/zh/vms/developer-reference/api-error-code?spm=a2c4g.11186623.0.0.321526dckd3diO).', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Success' => ['description' => 'Whether the request was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"95B86652-B234-5387-BAC6-E441FR49399F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"RingingRate\\": 25.4222,\\n \\"ResourceId\\": \\"无\\",\\n \\"RingingCount\\": 3,\\n \\"ResourceType\\": \\"无\\",\\n \\"RegionId\\": \\"无\\",\\n \\"CallConnectionRate\\": 6.71672,\\n \\"RequestCount\\": 49,\\n \\"CompleteCount\\": 52\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query answer rate for real numbers ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'QueryVmsVirtualNumberRelationByPage' => [ + 'summary' => 'Queries the list of binding relationships between virtual numbers and real numbers.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of results returned per page. Range: 1 to 100. Default value: 20.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => false, 'example' => '81'], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'Page number. Default value is **1**.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => false, 'example' => '74'], + ], + [ + 'name' => 'VirtualNumber', + 'in' => 'query', + 'schema' => ['description' => 'Virtual number', 'type' => 'string', 'required' => false, 'example' => '0571****1234', 'title' => ''], + ], + [ + 'name' => 'RealNumber', + 'in' => 'query', + 'schema' => ['description' => 'Actual phone number', 'type' => 'string', 'required' => false, 'example' => '131***1234', 'title' => ''], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => ['description' => 'Status. Valid values:'."\n" + ."\n" + .'- 1: Valid'."\n" + ."\n" + .'- 0: Invalid'."\n" + ."\n" + .'- -1: Unregister', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'NumberCity', + 'in' => 'query', + 'schema' => ['description' => 'Number\'s city of origin', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + [ + 'name' => 'NumberProvince', + 'in' => 'query', + 'schema' => ['description' => 'Number\'s province of origin', 'type' => 'string', 'required' => false, 'example' => '北京', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Deprecated parameter. Ignore it.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '01A58FA5-422C-58E0-AA71-B307A665416F'], + 'Message' => ['description' => 'Message returned in the result.', 'type' => 'string', 'title' => '', 'example' => '参数缺失！'], + 'Model' => [ + 'title' => '', + 'description' => 'Result.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'Number of entries displayed per page', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '65'], + 'Total' => ['description' => 'Total number of entries.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '231'], + 'PageNo' => ['description' => 'Current page number.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'List of returned objects', + 'type' => 'array', + 'items' => [ + 'description' => 'Returned object.', + 'type' => 'object', + 'properties' => [ + 'RealNumber' => ['description' => 'Real number', 'type' => 'string', 'example' => '131****1234', 'title' => ''], + 'VirtualNumber' => ['description' => 'Virtual number', 'type' => 'string', 'example' => '0571***1234', 'title' => ''], + 'State' => ['description' => 'Status. Valid values:'."\n" + ."\n" + .'- 1: Valid;'."\n" + ."\n" + .'- 0: Invalid;'."\n" + ."\n" + .'- -1: Unregister.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NumberCity' => ['description' => 'Number\'s city of origin', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'NumberProvince' => ['description' => 'Number\'s province of origin', 'type' => 'string', 'example' => '北京', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => ['description' => 'Request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error codes]().', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Success' => ['description' => 'Whether the API call was successful.'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"01A58FA5-422C-58E0-AA71-B307A665416F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"PageSize\\": 65,\\n \\"Total\\": 231,\\n \\"PageNo\\": 1,\\n \\"Data\\": [\\n {\\n \\"RealNumber\\": \\"131****1234\\",\\n \\"VirtualNumber\\": \\"0571***1234\\",\\n \\"State\\": 1,\\n \\"NumberCity\\": \\"北京\\",\\n \\"NumberProvince\\": \\"北京\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query the list of binding relationships between virtual numbers and real numbers ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'QueryVoiceFileAuditInfo' => [ + 'summary' => 'Queries the review state of a voice file.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '120076', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VoiceCodes', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the voice file. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications** or **Voice File Management**, and then click the **Voice Notification Files** tab to view the **voice ID**.'."\n" + ."\n" + .'> You can query up to 10 voice files each time. Separate the voice file names with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '8501d2eb-efbb-471f-xxx8-****.wav', 'title' => ''], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the voice file. Valid values:'."\n" + ."\n" + .'* **0** (default): the voice notification file.'."\n" + .'* **2**: the recording file.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [], + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'The value OK indicates that the request was successful. For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Return Results', + 'type' => 'object', + 'properties' => [ + 'VoiceCode' => ['description' => 'The code of the voice file.'."\n", 'type' => 'string', 'example' => '8501d2eb-efbb-471f-xxx8-****.wav', 'title' => ''], + 'AuditState' => ['description' => 'The review state of the voice file. Valid values:'."\n" + ."\n" + .'* **AUDIT_STATE_INIT**: The voice file was under review.'."\n" + .'* **AUDIT_STATE_PASS**: The voice file was approved.'."\n" + .'* **AUDIT_STATE_NOT_PASS**: The voice file was rejected.'."\n" + .'* **AUDIT_STATE_UPLOADING**: The voice file was approved and is being uploaded.'."\n" + .'* **AUDIT_STATE_REDOING**: The voice file was being reprocessed.'."\n" + .'* **AUDIT_SATE_CANCEL**: The review of the voice file was canceled.'."\n" + .'* **AUDIT_PAUSE**: The review of the voice file was suspended.'."\n" + .'* **AUDIT_ORDER_FINISHED**: The voice file was approved by the ticket system and was waiting for the review of the Internet service provider (ISP).'."\n", 'type' => 'string', 'example' => 'AUDIT_STATE_NOT_PASS', 'title' => ''], + 'RejectInfo' => ['description' => 'The reason why the voice file was rejected.'."\n", 'type' => 'string', 'example' => '如电话沟通，该业务暂不支持', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Query.Voice.File.Limit', 'errorMessage' => 'Voice file query number cannot exceed 10', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"VoiceCode\\": \\"8501d2eb-efbb-471f-xxx8-****.wav\\",\\n \\"AuditState\\": \\"AUDIT_STATE_NOT_PASS\\",\\n \\"RejectInfo\\": \\"如电话沟通，该业务暂不支持\\"\\n }\\n ],\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'QueryVoiceFileAuditInfo', + 'changeSet' => [ + ['createdAt' => '2022-01-21T07:27:55.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2022-01-20T03:59:08.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVoiceFileAuditInfo'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVoiceFileAuditInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'RecoverCallInConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => ['description' => 'The China 400 number that is used to transfer the inbound call.'."\n", 'type' => 'string', 'required' => true, 'example' => '400***', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainApiResponse', + 'description' => 'PlainApiResponse'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'Indicates whether the inbound call was resumed. Valid values:'."\n" + ."\n" + .'* true: The inbound call was resumed.'."\n" + .'* false: The inbound call failed to be resumed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', 'title' => ''], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '成功', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', + 'title' => 'RecoverCallInConfig', + 'summary' => 'Resumes the inbound call that is transferred by using a China 400 number.', + 'changeSet' => [ + ['createdAt' => '2022-04-20T03:08:44.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverCallInConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:RecoverCallInConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ResumeVideoFile' => [ + 'summary' => 'Resumes video playback in a voice call after it has been paused.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201535', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The call ID. You can get the CallId from the response parameters of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) API.', 'type' => 'string', 'required' => false, 'example' => '100001616500^1000018****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number for which to resume video playback.', 'type' => 'string', 'required' => true, 'example' => '159****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Data' => ['description' => 'Details of the returned data.', 'type' => 'object', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- A return value of OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [Error code list](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- true: The call succeeded.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Resume Video', + 'description' => 'The 5G video calling feature is available by invitation only. Contact your account manager to enable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:ResumeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SendVerification' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52709', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VerifyType', + 'in' => 'query', + 'schema' => ['description' => 'The mode of sending the SMS verification code. Set the value to **SMS**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => 'The business type. Set the value to **CONTACT**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CONTACT', 'title' => ''], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number that receives the SMS verification code.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '150****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the verification code was sent successfully.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Mobile.Invalid', 'errorMessage' => 'The mobile number is invalid.', 'description' => ''], + ['errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'You have not been authorized.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","errorExample":""},{"type":"xml","example":"\\nOK\\n6086693B-2250-17CE-A41F-06259AB6DB1B\\ntrue\\nOK\\n","errorExample":""}]', + 'title' => 'SendVerification', + 'summary' => 'Sends an SMS verification code.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-28T01:51:14.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendVerification'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SendVerification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SetTransferCalleePoolConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Details', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the phone numbers for transferring the call.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Caller' => ['description' => 'The calling number.'."\n", 'type' => 'string', 'required' => false, 'example' => '150****0000', 'title' => ''], + 'Called' => ['description' => 'The called number.'."\n", 'type' => 'string', 'required' => true, 'example' => '151****0000', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => ['description' => 'The phone number used for transferring the call.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400903****', 'title' => ''], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => ['description' => 'The qualification ID. You can call the [GetHotlineQualificationByOrder](~~393548~~) operation to obtain the qualification ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '190***', 'title' => ''], + ], + [ + 'name' => 'CalledRouteMode', + 'in' => 'query', + 'schema' => ['description' => 'The call mode. Valid values:'."\n" + ."\n" + .'* **roundRobin**'."\n" + .'* **random**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'roundRobin', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the phone numbers for transferring the call were configured.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E7518CE1-B0FF-4C6F-9252-BF80271B2F99', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E7518CE1-B0FF-4C6F-9252-BF80271B2F99\\"\\n}","type":"json"}]', + 'title' => 'SetTransferCalleePoolConfig', + 'summary' => 'Sets the phone numbers for transferring a call.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetTransferCalleePoolConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SetTransferCalleePoolConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SingleCallByTts' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52711', + 'abilityTreeNodes' => ['FEATUREdyvmsX55VQQ'], + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number displayed to the called party.'."\n" + ."\n" + .'* You do not need to specify this parameter if you use the text-to-speech (TTS) notification template or voice verification code template for outbound calls in the common mode. For more information, see [FAQ about the common outbound call mode](~~172104~~).'."\n" + .'* If you use the TTS notification template or voice verification code template for outbound calls in the dedicated mode, you must specify a number you purchased and only one number can be specified. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home) and choose **Voice Numbers** > **Real Number Management** to view the number you purchased.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0571****5678', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number that receives voice notifications.'."\n" + ."\n" + .'* Number format in the Chinese mainland:'."\n" + ."\n" + .' * Mobile phone number, for example, 159\\*\\*\\*\\*0000.'."\n" + .' * Landline number, for example, 0571\\*\\*\\*\\*5678.'."\n" + ."\n" + .'* Number format outside the Chinese mainland: country code + phone number, for example, 85200\\*\\*\\*\\*00.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Each request supports only one called number. For more information, see [How to use voice notifications in the Chinese mainland](~~150016~~) or [How to use voice verification codes in regions outside the Chinese mainland](~~270044~~).'."\n" + ."\n" + .'* Voice verification codes are sent to a called number at the following frequency: one time per minute, five times per hour, and 20 times per 24 hours.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1590****000', 'title' => ''], + ], + [ + 'name' => 'TtsCode', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the approved TTS notification template or voice verification code template.'."\n" + ."\n" + .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), and choose **Voice Messages** > **Voice Verification Codes** or choose **Voice Messages** > **Voice Notifications** to view the **template ID**.'."\n" + ."\n" + .'> The account to which the TTS template belongs must be the same as the account that is used to call the SingleCallByTts operation.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TTS_28726****', 'title' => ''], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => ['description' => 'The variables in the template, in the JSON format.'."\n" + ."\n" + .'> The variables in the template must be less than 250 characters in length. The length of each single variable is not limited. These variables do not support URLs. The variables in the verification code template support only digits and letters.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"AckNum":"123456"}', 'title' => ''], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of times a voice notification is played back in a call. Valid values: 1 to 3. Default value: 3.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => 'The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => 'The playback speed. Valid value: -500 to 500.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'The custom ID that is reserved for the caller of the operation when the request is initiated. This ID is returned to the caller in a receipt message.'."\n" + ."\n" + .'The value is of the STRING type and must be 1 to 15 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '225869*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + 'CallId' => ['description' => 'The unique receipt ID of the call.'."\n" + ."\n" + .'You can call the [QueryCallDetailByCallId](~~393529~~) operation to query the details of the call based on the receipt ID.'."\n", 'type' => 'string', 'example' => '116012354148^10281378****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', + 'title' => 'SingleCallByTts', + 'summary' => 'Sends a voice verification code or a voice notification with variables to a specified phone number.', + 'description' => '* Due to business adjustments, the updates of the voice notification and voice verification code services have been stopped in regions outside the Chinese mainland and the services have been discontinued since March 2022. Only qualified customers can continue using the voice notification and voice verification code services.'."\n" + .'* For more information about voice plans or voice service billing, see [Pricing of VMS on China site (aliyun.com)](~~150083~~).'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-06-22T12:03:17.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByTts'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByTts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SingleCallByVideo' => [ + 'summary' => 'Calls a single phone number and plays a voice or video file.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '216178', + 'abilityTreeNodes' => ['FEATUREdyvmsX55VQQ'], + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => 'The outbound number for the video notification. This is the number displayed to the callee.'."\n" + ."\n" + .'- If you use a number in common pattern, do not specify this parameter. For more information, see [Common pattern](~~172104~~).'."\n" + ."\n" + .'- If you use a number in exclusive pattern, specify your **real number** or **virtual number**.'."\n" + .' Log on to the [Voice Service console](https://dyvms.console.aliyun.com/number/list/normal). On the **Real Number Management** page, view your purchased **real numbers**. On the **Virtual Number Management** page, view the **virtual numbers** that you created and attached to real numbers.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0571****5678', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The phone number that receives the video notification.'."\n" + ."\n" + .'The number must be in one of the following formats:'."\n" + ."\n" + .'- A mobile phone number. Example: 159\\*\\*\\*\\*0000.'."\n" + ."\n" + .'- A landline number. Example: 0571\\*\\*\\*\\*5678.'."\n" + ."\n" + .'- Country code+Number. Example: 85200\\*\\*\\*\\*00.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1590****000', 'title' => ''], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => ['description' => 'The voice ID of the voice notification file.'."\n" + ."\n" + .'Log on to the [Voice Service console](https://dyvms.console.aliyun.com/overview/home) to obtain the voice ID from one of the following pages. The voice notification file must be approved.'."\n" + ."\n" + .'- On the **Voice Messaging** > **Voice Notifications** > **Voice Notification Files** page, obtain the **Voice ID**.'."\n" + ."\n" + .'- On the **Voice File Management** > **Voice Notification Files** page, obtain the **Voice ID**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '17d37e58-2a09-419f-9b3d-e7e4b4****dd.wav', 'title' => ''], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of times the notification file is played. Valid values: **1 to 3**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => 'The playback volume of the notification file. Valid values: **0 to 100**. The default value is **100**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => 'The playback speed of the voice file. Valid values: **-500 to 500**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'A custom ID that you can specify when you initiate a request. This ID is returned to you in a receipt message.'."\n" + ."\n" + .'A string of 1 to 15 characters.', 'type' => 'string', 'required' => false, 'example' => 'abcdefgh', 'title' => ''], + ], + [ + 'name' => 'VideoCode', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the video notification file.'."\n" + ."\n" + .'You can view the IDs of approved video notification files on the [Video Notification Files](https://dyvms.console.aliyun.com/videoFiles/list/notify) page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1120213841979436_20240621103****39_.mp4'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- A value of OK indicates that the request was successful.'."\n" + ."\n" + .'- For more information about other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', 'title' => ''], + 'CallId' => ['description' => 'The unique ID of the voice or video notification.'."\n" + ."\n" + .'You can use this parameter to call operations such as [PlayVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-playvideofile?spm) to play a video.'."\n" + .'You can [configure receipt messages](https://help.aliyun.com/zh/vms/developer-reference/return-receipt-message-description-and-configuration-process?spm) to obtain call records, intermediate call status messages, and recording records.', 'type' => 'string', 'example' => '116012354148^10281378****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', + 'title' => 'Send Video Notification ', + 'description' => '- The 5G video call feature is available by invitation only. Contact your account manager to enable this feature.'."\n" + ."\n" + .'- After you initiate a call, you can also call the [PlayVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-playvideofile?spm), [PauseVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-pausevideofile?spm), and [ResumeVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-resumevideofile?spm) operations to play, pause, and resume the video during the call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVideo'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SingleCallByVoice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52712', + 'abilityTreeNodes' => ['FEATUREdyvmsX55VQQ'], + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number displayed to the called party.'."\n" + ."\n" + .'* You do not need to specify this parameter if you use a voice notification file that uses the common outbound call mode. For more information, see [FAQ about the common outbound call mode](~~172104~~).'."\n" + .'* If you use a voice notification file that uses the dedicated outbound call mode, you must specify a number that you purchased. You can specify only one number. 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 number that you purchased.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0571****5678', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number for receiving voice notifications.'."\n" + ."\n" + .'Number format:'."\n" + ."\n" + .'* In the Chinese mainland:'."\n" + ."\n" + .' * Mobile phone number, for example, 159\\*\\*\\*\\*0000.'."\n" + .' * Landline number, for example, 0571\\*\\*\\*\\*5678.'."\n" + ."\n" + .'* Outside the Chinese mainland: country code + phone number, for example, 85200\\*\\*\\*\\*00.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can specify only one called number for a request. For more information, see [How to use voice notifications in the Chinese mainland](~~150016~~) or [How to use voice notifications in regions outside the Chinese mainland](~~268810~~).'."\n" + ."\n" + .'* Voice notifications are sent to a called number at the following frequency: one time per minute, five times per hour, and 20 times per 24 hours.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '159****0000', 'title' => ''], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => ['description' => 'The voice ID of the voice notification file.'."\n" + ."\n" + .'You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications** or **Voice File Management**, and then click the **Voice Notification Files** tab to view the **voice ID**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', 'title' => ''], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of times the voice notification file is played. Valid values: 1 to 3.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => 'The playback volume of the voice notification file. Valid values: 0 to 100. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => 'The playback speed of the voice notification file. Valid values: -500 to 500.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message.'."\n" + ."\n" + .'The value must be of the STRING type and 1 to 15 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '22596****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.****'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E50FFA85-0B79-4421-A7BD-00B0A271966F', 'title' => ''], + 'CallId' => ['description' => 'The unique receipt ID for the call.'."\n" + ."\n" + .'You can call the [QueryCallDetailByCallId](~~393529~~) operation to query the details of the call.'."\n", 'type' => 'string', 'example' => '116004767703^102806****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"E50FFA85-0B79-4421-A7BD-00B0A271966F\\",\\n \\"CallId\\": \\"116004767703^102806****\\"\\n}","type":"json"}]', + 'title' => 'SingleCallByVoice', + 'summary' => 'Sends a voice notification to a phone number by using a voice notification file.', + 'description' => '> Due to business adjustments, the updates of the voice notification and voice verification code services have been stopped in regions outside the Chinese mainland and the services have been discontinued since March 2022. Only qualified customers can continue using the voice notification and voice verification code services.'."\n" + ."\n" + .'You can call the [SingleCallByTts](~~393519~~) operation to send voice notifications with variables.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 1,200 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-10-26T08:14:58.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVoice'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SkipVideoFile' => [ + 'summary' => 'You can call this operation to fast-forward or rewind a video during playback.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '218113', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'Call ID. You can get the CallId from the response of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) operation.', 'type' => 'string', 'required' => false, 'example' => '116012854210^10281427****', 'title' => ''], + ], + [ + 'name' => 'SkipTimes', + 'in' => 'query', + 'schema' => ['description' => 'Time in milliseconds to skip to for video playback.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '04:02:01', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'A custom ID for the caller. This ID is returned to the caller in the callback message.'."\n" + ."\n" + .'This is a string of 1 to 15 bytes.', 'type' => 'string', 'required' => false, 'example' => 'PR0210428****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'Mobile phone number that receives the video playback.', 'type' => 'string', 'required' => true, 'example' => '159****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Detailed information about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Data' => ['description' => 'Response data.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Code' => ['description' => 'Request status code.'."\n" + ."\n" + .'- OK means the request succeeded.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation succeeded.'."\n" + ."\n" + .'- **true**: The operation succeeded.'."\n" + ."\n" + .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Fast-forward or rewind video ', + 'description' => 'The 5G video call feature is currently available by invitation only. Contact your account manager to enable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SkipVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - [ - 'regionId' => 'cn-shanghai-et2-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'SmartCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52713', + 'abilityTreeNodes' => ['FEATUREdyvms59DC26'], + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => 'Displayed number for the called party. This must be a number you have purchased.'."\n" + ."\n" + .'Log on to the [Voice Service console](https://dyvms.console.aliyun.com/overview/home). Go to **Voice Numbers** > **Real Number Management** to view your purchased numbers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571****5678', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'Called number. Only numbers from the Chinese mainland are supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1590****0000', 'title' => ''], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => ['description' => 'Voice file for smart outbound calls.'."\n" + ."\n" + .'If the voice file is uploaded to the console, set **VoiceCode** to the voice ID of the file. Log on to the [Voice Service console](https://dyvms.console.aliyun.com/overview/home). Go to **Voice File Management** > **Intelligent Speech Interaction Voice Files**. Click **Details** to view the voice ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', 'title' => ''], + ], + [ + 'name' => 'RecordFlag', + 'in' => 'query', + 'schema' => ['description' => 'Whether to record the call. Valid values:'."\n" + ."\n" + .'- **true**: Record the call.'."\n" + ."\n" + .'- **false**: Do not record the call.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => 'Volume for playing audio. Valid values: -4 to **4**. We recommend setting this to **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not supported.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AsrModelId', + 'in' => 'query', + 'schema' => ['description' => 'The Automatic Speech Recognition (ASR) model. The valid values are:'."\n" + ."\n" + .'- **customer\\_service\\_8k** (default): Mandarin.'."\n" + ."\n" + .'- **dialect\\_customer\\_service\\_8k**: Mandarin with a strong accent.'."\n" + ."\n" + .'> When you call the SmartCall operation, you can specify the ASR model by setting either the AsrModelId or AsrBaseId parameter.'."\n" + .'>'."\n" + .'> - If you set only the AsrModelId parameter, the system uses the specified ASR model.'."\n" + .'>'."\n" + .'> - If you set only the AsrBaseId parameter, the system uses the specified ASR foundation model.'."\n" + .'>'."\n" + .'> - If you do not set either parameter, the system uses the default ASR foundation model. The AsrBaseId parameter defaults to customer\\_service\\_8k, which is the Mandarin ASR foundation model.'."\n" + .'>'."\n" + .'> - If you set both parameters, confirm that they are compatible.', 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k', 'title' => ''], + ], + [ + 'name' => 'PauseTime', + 'in' => 'query', + 'schema' => ['description' => 'Pause duration. Sets how long a user must pause before the system treats it as the end of a sentence. Unit: milliseconds. Valid values: 300 to **1200**.'."\n" + ."\n" + .'> - If the value is outside this range, the default value **800** is used.'."\n" + .'>'."\n" + .'> - This parameter takes effect only the first time it is set.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800', 'title' => ''], + ], + [ + 'name' => 'MuteTime', + 'in' => 'query', + 'schema' => ['description' => 'Mute duration. Sets how long a user must remain silent before the call ends. Unit: milliseconds. Valid values: 1000 to **20000**.'."\n" + ."\n" + .'> - If the value is outside this range, the default value **10000** is used.'."\n" + .'>'."\n" + .'> - You can set this parameter dynamically during the call. The last setting takes effect.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'ActionCodeBreak', + 'in' => 'query', + 'schema' => ['description' => 'Whether the current media file can be interrupted. Default value: **true**.'."\n" + ."\n" + .'If this is false, the current playback cannot be interrupted—even if the next action (action\\_break) is true.'."\n" + ."\n" + .'> action\\_code\\_break has higher priority than action\\_break.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'ID reserved for the caller. This ID is returned to the caller in the callback message.'."\n" + ."\n" + .'String. Length: 1 to 15 bytes.', 'type' => 'string', 'required' => false, 'example' => '342268*****', 'title' => ''], + ], + [ + 'name' => 'DynamicId', + 'in' => 'query', + 'schema' => ['description' => 'Dynamic extension ID reserved for the caller. Returned in the callback URL for developer identification.', 'type' => 'string', 'required' => false, 'example' => 'abcdefgh', 'title' => ''], + ], + [ + 'name' => 'EarlyMediaAsr', + 'in' => 'query', + 'schema' => ['description' => 'Early media speech recognition flag. Valid values:'."\n" + ."\n" + .'- **false** (default): Disabled.'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + ."\n" + .'> Set this to **true** to record why the call was not answered.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'VoiceCodeParam', + 'in' => 'query', + 'schema' => ['description' => 'TTS parameter string in JSON format. Must match the TTS parameters in **VoiceCode**.', 'type' => 'string', 'required' => false, 'example' => '{"name":"喂,你好"}', 'title' => ''], + ], + [ + 'name' => 'SessionTimeout', + 'in' => 'query', + 'schema' => ['description' => 'Maximum call duration. The call ends automatically after this time. Unit: seconds.'."\n" + ."\n" + .'> Maximum duration is 3600 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'ActionCodeTimeBreak', + 'in' => 'query', + 'schema' => ['description' => 'Interrupt based on continuous speech duration. Unit: milliseconds.'."\n" + ."\n" + .'If ActionCodeBreak is true, continuous speech interrupts the current playback. If this parameter is not set or is **0**, it does not take effect.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'TtsStyle', + 'in' => 'query', + 'schema' => ['description' => 'Voice style for TTS variables. Default value: **xiaoyun**. For a full list, see **Voice Styles**.', 'type' => 'string', 'required' => false, 'example' => 'xiaoyun', 'title' => ''], + ], + [ + 'name' => 'TtsVolume', + 'in' => 'query', + 'schema' => ['description' => 'Volume for playing TTS variables. Valid values: 0 to **100**. Default value: **0**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TtsSpeed', + 'in' => 'query', + 'schema' => ['description' => 'Speech speed for TTS variables. Valid values: -200 to **200**. Default value: **0**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'TtsConf', + 'in' => 'query', + 'schema' => ['description' => 'Whether to configure TTS voice settings. Valid values:'."\n" + ."\n" + .'- **true**: Configure. Use **TtsStyle**, **TtsVolume**, and **TtsSpeed** to set voice style.'."\n" + ."\n" + .'- **false**: Do not configure. Other TTS parameters are ignored even if set.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AsrBaseId', + 'in' => 'query', + 'schema' => ['description' => 'ASR foundation model. Valid values:'."\n" + ."\n" + .'- **customer\\_service\\_8k** (default): Mandarin.'."\n" + ."\n" + .'- **dialect\\_customer\\_service\\_8k**: Heavy accent.'."\n" + ."\n" + .'> When you call the SmartCall API, specify an ASR model. Set either AsrModelId or AsrBaseId, but not both.'."\n" + .'>'."\n" + .'> - If you set only AsrModelId, the specified ASR model is used.'."\n" + .'>'."\n" + .'> - If you set only AsrBaseId, the specified ASR foundation model is used.'."\n" + .'>'."\n" + .'> - If you set neither, the default ASR foundation model is used. The default value of AsrBaseId is customer\\_service\\_8k, which means the Mandarin ASR foundation model is used.'."\n" + .'>'."\n" + .'> - If you set both, make sure they match correctly.', 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k', 'title' => ''], + ], + [ + 'name' => 'StreamAsr', + 'in' => 'query', + 'schema' => ['description' => 'Streaming ASR. Uses the first few spoken words to infer meaning. Valid values:'."\n" + ."\n" + .'- **0**: Disabled.'."\n" + ."\n" + .'- **1**: Enabled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'BackgroundFileCode', + 'in' => 'query', + 'schema' => ['description' => 'Background voice file ID played during user-robot conversations.'."\n" + ."\n" + .'Log on to the [Voice Service console](https://dyvms.console.aliyun.com/overview/home). Go to **Voice File Management** > **Intelligent Speech Interaction Voice Files**. Click **Details** to view the voice ID.', 'type' => 'string', 'required' => false, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', 'title' => ''], + ], + [ + 'name' => 'BackgroundVolume', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not supported.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '4', 'minimum' => '-4', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'BackgroundSpeed', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not supported.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'EnableITN', + 'in' => 'query', + 'schema' => ['description' => 'Whether to apply inverse text normalization (ITN) during post-processing. Default value: **false**.'."\n" + ."\n" + .'If set to **true**, Chinese numerals convert to Arabic numerals in output.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'NoiseThreshold', + 'in' => 'query', + 'schema' => ['type' => 'number', 'format' => 'double', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response data.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Request status code.'."\n" + ."\n" + .'- OK means the request succeeded.'."\n" + ."\n" + .'- For other error codes, see [API Error Codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'Description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''], + 'CallId' => ['description' => 'Unique receipt ID for this call.'."\n" + ."\n" + .'Use the [QueryCallDetailByCallId](~~QueryCallDetailByCallId~~) API to query call details by CallId.', 'type' => 'string', 'example' => '116012854210^10281427****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"CallId\\": \\"116012854210^10281427****\\"\\n}","type":"json"}]', + 'title' => 'SmartCall', + 'summary' => 'Intelligent Speech Interaction is a human-machine interaction technology that enables users to hold natural, voice-based conversations with machines.', + 'description' => '- You can use SmartCall with the [Smart Outbound Call HTTP Callback Interface](~~112703~~). After the voice platform initiates a call, it sends the transcribed speech text to your business system. Your business system then returns the next action to the voice platform.'."\n" + ."\n" + .'- The following characters are not allowed in SmartCall callbacks: `@ = : "" $ { } ^ * ￥`.', + 'requestParamsDescription' => '### Voice Styles'."\n" + ."\n" + .'For more information, see [Voice Styles](https://help.aliyun.com/zh/vms/sound-style).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-18T02:28:38.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCall'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SmartCallOperate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52714', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The unique receipt ID of the call. You can call the [SmartCall](~~393526~~) operation to obtain the receipt ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '116012854210^1028142****', 'title' => ''], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => ['description' => 'The action that is initiated to the called number of an outbound robocall.'."\n" + ."\n" + .'> Only the value **parallelBridge** is supported. This value indicates that a bridge action is initiated between a called number and an agent of the call center.'."\n", 'type' => 'string', 'required' => true, 'example' => 'parallelBridge', 'title' => ''], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => ['description' => 'The extended field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Param', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The action result. Valid values:'."\n" + ."\n" + .'* **true**: The action was successful.'."\n" + .'* **false**: The action failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\tOK\\r\\n\\tOK\\r\\n\\tA90E4451-FED7-49D2-87C8-00700A8C4D0D\\r\\n\\ttrue\\r\\n","errorExample":""}]', + 'title' => 'SmartCallOperate', + 'summary' => 'Initiates an action in an outbound robocall. This operation is applicable only when the robocall is transferred to an agent or an agent is listening in on the conversation between the robot and the user.', + 'description' => 'You can call this operation to initiate a specified action on the called number of an outbound robocall when the call is transferred to an agent of the call center.'."\n" + ."\n" + .'> You can only initiate the action of bridging a called number and an agent of the call center.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCallOperate'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCallOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'StartRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '104500****', 'title' => ''], + ], + [ + 'name' => 'ScheduleTime', + 'in' => 'query', + 'schema' => ['description' => 'The time scheduled for starting the robocall task, in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-14 14:55:23', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\ttrue\\n","errorExample":""}]', + 'title' => 'StartRobotTask', + 'summary' => 'Starts a robocall task immediately or at a scheduled time.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StartRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'StopCallInConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '135026', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => ['description' => 'The China 400 number from which the inbound call to be stopped is transferred.'."\n", 'type' => 'string', 'required' => true, 'example' => '400***', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainApiResponse', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'Indicates whether the inbound call was stopped. Valid values:'."\n" + ."\n" + .'* true: The inbound call was stopped.'."\n" + .'* false: The inbound call failed to be stopped.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', 'title' => ''], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '成功', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', + 'title' => 'StopCallInConfig', + 'summary' => 'Stops the inbound call that is transferred from a China 400 number.', + 'changeSet' => [ + ['createdAt' => '2022-04-20T03:08:44.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopCallInConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:StopCallInConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - [ - 'regionId' => 'cn-shanghai-inner', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'StopRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\ttrue\\n","errorExample":""}]', + 'title' => 'StopRobotTask', + 'summary' => 'Stops a robocall task that is in progress.', + 'description' => 'After you stop a robocall task, you can call the [StartRobotTask](~~StartRobotTask~~) operation to start it again.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StopRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - [ - 'regionId' => 'cn-shanghai-internal-test-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'SubmitHotlineTransferRegister' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TransferPhoneNumberInfos', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The registration information about the China 400 number.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => ['description' => 'The China 400 number that you want to submit for registration.'."\n", 'type' => 'string', 'required' => true, 'example' => '1580000****', 'title' => ''], + 'PhoneNumberOwnerName' => ['description' => 'The real name or company name of the number owner.'."\n", 'type' => 'string', 'required' => true, 'example' => 'A***', 'title' => ''], + 'IdentityCard' => ['description' => 'The ID card number of the number owner.'."\n", 'type' => 'string', 'required' => true, 'example' => '500***', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => ['description' => 'The qualification ID. You can call the [GetHotlineQualificationByOrder](~~393548~~) operation to obtain the qualification ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000004933****', 'title' => ''], + ], + [ + 'name' => 'OperatorName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the handler.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'A***', 'title' => ''], + ], + [ + 'name' => 'OperatorMail', + 'in' => 'query', + 'schema' => ['description' => 'The email address of the handler.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', 'title' => ''], + ], + [ + 'name' => 'OperatorMailVerifyCode', + 'in' => 'query', + 'schema' => ['description' => 'The verification code that is received by the mailbox of the handler.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'OperatorMobile', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number of the handler.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '158****7230', 'title' => ''], + ], + [ + 'name' => 'OperatorMobileVerifyCode', + 'in' => 'query', + 'schema' => ['description' => 'The verification code that is received by the mobile phone of the handler.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'OperatorIdentityCard', + 'in' => 'query', + 'schema' => ['description' => 'The ID card number of the handler.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5****************9', 'title' => ''], + ], + [ + 'name' => 'Agreement', + 'in' => 'query', + 'schema' => ['description' => 'The authenticity of the commitment. Valid values:'."\n" + ."\n" + .'* **true**: The commitment is authentic.'."\n" + .'* **false**: The commitment is not authentic.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'HotlineNumber', + 'in' => 'query', + 'schema' => ['description' => 'The China 400 number.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The registration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2258****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Mobile.Invalid', 'errorMessage' => 'The mobile number is invalid.', 'description' => ''], + ['errorCode' => 'MobileVerifyCode.Invalid', 'errorMessage' => 'The mobile verification code is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","type":"json"}]', + 'title' => 'SubmitHotlineTransferRegister', + 'summary' => 'Submits a 400 number for registration.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-28T01:51:14.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotlineTransferRegister'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SubmitHotlineTransferRegister', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'UpgradeVideoFile' => [ + 'summary' => 'Upgrades voice calls to video calls.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '217976', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The call ID. Get the CallId from the return parameters of the [SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm) API.', 'type' => 'string', 'required' => false, 'example' => '116012354148^10281378****', 'title' => ''], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => 'The media type. The value is fixed to **video**.', 'type' => 'string', 'required' => false, 'example' => 'video', 'default' => 'VIDEO', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'The ID reserved for the caller. This ID is returned to the caller in the receipt message.'."\n" + ."\n" + .'This is a string with a length limit of 1 to 15 characters.', 'type' => 'string', 'required' => false, 'example' => '225869*****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number that receives video calls.', 'type' => 'string', 'required' => true, 'example' => '159****0000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Access denied details.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Data' => ['description' => 'The returned data content.', 'type' => 'object', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + ."\n" + .'- For other error codes, see [API error codes](~~112502~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Video Upgrade', + 'description' => 'The 5G video call feature is currently available by invitation only. Contact your operations manager to enable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:UpgradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'UploadRobotTaskCalledFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the ID of the robocall task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045****', 'title' => ''], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'The called numbers. Separate multiple called numbers with commas (,).'."\n" + ."\n" + .'> After you create a robocall task, you must upload called numbers in batches. You can upload up to 300,000 called numbers for each task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1370****000,1370****111', 'title' => ''], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => ['description' => 'The values of the variable in the text-to-speech (TTS) template, in the JSON format. The variable values specified by the TtsParam parameter must match the variable names specified by the TtsParamHead parameter.'."\n" + ."\n" + .'* If all the called numbers carry the same variable values, you can set the value of the number field to **all** and upload only one copy of the variable values.'."\n" + .'* If only some of the called numbers carry the same variable values, you can set the value of the number field to **all** for these called numbers and set the value of the number field and variable values for other called numbers based on your business requirements. The system preferentially selects the values that you set for the called numbers.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{"number":"1370****000","params":["小王","小李","小周"]}]', 'title' => ''], + ], + [ + 'name' => 'TtsParamHead', + 'in' => 'query', + 'schema' => ['description' => 'The list of variable names carried in the robocall task, in the JSON format. The TtsParamHead parameter must be used together with the TtsParam parameter.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["name1","name2","name3"]', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~112502~~).'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The unique ID of the robocall task.'."\n" + ."\n" + .'You can call the [QueryRobotTaskDetail](~~QueryRobotTaskDetail~~) operation to query the details of the robocall task based on the task ID.'."\n", 'type' => 'string', 'example' => '10450****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10450****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tOK\\n\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n\\tOK\\n\\t10450****\\n","errorExample":""}]', + 'title' => 'UploadRobotTaskCalledFile', + 'summary' => 'Uploads the called numbers of a robocall task.', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadRobotTaskCalledFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:UploadRobotTaskCalledFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => 'dyvmsapi.vpc-proxy.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => 'dyvmsapi-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => '100008.0', 'message' => 'Data not available.', 'http_code' => 400, 'description' => 'Data not available.'], + ['code' => 'BillidNotExist', 'message' => 'The bill ID does not exist.', 'http_code' => 400, 'description' => 'The specified bill ID does not exist.'], + ['code' => 'ComplaintReject', 'message' => 'The call has been blocked due to complaints.', 'http_code' => 400, 'description' => 'The complaint is rejected.'], + ['code' => 'InternalError', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => 'An internal server error occurred.'], + ['code' => 'InvalidParameter.date', 'message' => 'date not invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameters', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], + ['code' => 'InvalidParameters', 'message' => 'Invalid Parameters.', 'http_code' => 400, 'description' => 'Illegal parameter.'], + ['code' => 'isp.GATEWAY_ERROR', 'message' => 'Gateway error.', 'http_code' => 500, 'description' => 'Gateway error.'], + ['code' => 'isp.RAM_PERMISSION_DENY', 'message' => 'The RAM permission is denied.', 'http_code' => 400, 'description' => 'Ram premission is denied.'], + ['code' => 'isp.RES_OWNER_ID_UNKNOWN', 'message' => 'The Alibaba Cloud account is not found.', 'http_code' => 400, 'description' => 'Alibaba ownerID is unknown.'], + ['code' => 'isp.SYSTEM_ERROR', 'message' => 'System error.', 'http_code' => 500, 'description' => 'System error.'], + ['code' => 'isp.UNKNOWN', 'message' => 'Unknown error.', 'http_code' => 400, 'description' => 'Unknown error.'], + ['code' => 'isp.USER_ASSERT_NOT_EXIST', 'message' => 'Failed to obtain user information.', 'http_code' => 400, 'description' => 'Assert user\'s information failed.'], + ['code' => 'isp.USER_NOT_EXIST', 'message' => 'The user information does not exist.', 'http_code' => 400, 'description' => 'User\'s information is not exist.'], + ['code' => 'isv.ACCOUNT_ABNORMAL', 'message' => 'Account is abnormal.', 'http_code' => 400, 'description' => 'Account is abnormal.'], + ['code' => 'isv.ACCOUNT_NOT_EXISTS', 'message' => 'The account is not found.', 'http_code' => 400, 'description' => 'Account is not exist.'], + ['code' => 'isv.AMOUNT_NOT_ENOUG', 'message' => 'Insufficient account balance.', 'http_code' => 400, 'description' => 'Insufficient account balance'], + ['code' => 'isv.ASR_MODEL_ERROR', 'message' => 'No permissions to use the ASR model.', 'http_code' => 400, 'description' => 'ASR model is unauthorized。'], + ['code' => 'isv.BILLID_NOT_EXIST', 'message' => 'Billid is not found.', 'http_code' => 400, 'description' => 'Billid is not exist.'], + ['code' => 'isv.BLACK_KEY_CONTROL_LIMIT', 'message' => 'Blacklist keyword exists in template variables.', 'http_code' => 400, 'description' => 'Blacklist keyword exists in template variables.'], + ['code' => 'isv.BUSINESS_LIMIT_CONTROL', 'message' => 'Throttling has been triggered.', 'http_code' => 400, 'description' => 'Hit the limitation of business frequence. The frequence limitation contains the type of minute, hour and day.'], + ['code' => 'isv.BUSINESS_LIMIT_CONTROL', 'message' => 'The business limit has been reached.', 'http_code' => 400, 'description' => 'Business frequence is limited'], + ['code' => 'isv.COMPLAINT_REJECT', 'message' => 'Stopped by nuisance blocker.', 'http_code' => 400, 'description' => 'Anti-disturbance interception'], + ['code' => 'isv.DISPLAY_NUMBER_ILLEGAL', 'message' => 'Invalid display number.', 'http_code' => 400, 'description' => 'Display number is illegal.'], + ['code' => 'isv.HIT_VOICE_SECURITY_RULE', 'message' => 'Stopped by security control.', 'http_code' => 400, 'description' => 'Hit the voice security rule.'], + ['code' => 'isv.INVALID_JSON_PARAM', 'message' => 'Invalid JSOM parameter.', 'http_code' => 400, 'description' => 'JSON param is invalid.'], + ['code' => 'isv.INVALID_PARAMETERS', 'message' => 'Parameters are invalid.', 'http_code' => 400, 'description' => 'Parameters are invalid.'], + ['code' => 'isv.MOBILE_COUNT_OVER_LIMIT', 'message' => 'The maximum number of phone numbers has been exceeded.', 'http_code' => 400, 'description' => 'Mobile phone numbers count exceeds the limit'], + ['code' => 'isv.MOBILE_NUMBER_ILLEGAL', 'message' => 'Invalid phone number format.', 'http_code' => 400, 'description' => 'Phone number format is illegal.'], + ['code' => 'isv.OUT_OF_SERVICE', 'message' => 'Account is out of service.', 'http_code' => 400, 'description' => 'Account is out of service.'], + ['code' => 'isv.PARAM_LENGTH_LIMIT', 'message' => 'Invalid template parameter length.', 'http_code' => 400, 'description' => 'Template param length is limited.'], + ['code' => 'isv.PARAM_LENGTH_LIMIT', 'message' => 'The parameter value length is over the limit.', 'http_code' => 400, 'description' => 'Param length is limited.'], + ['code' => 'isv.PARAM_NOT_SUPPORT_URL', 'message' => 'URLs are not supported for the parameter.', 'http_code' => 400, 'description' => 'URL param is not supported.'], + ['code' => 'isv.PHONE_NUMBER_IN_BLACK_LIST', 'message' => 'Phone number is in the blacklist.', 'http_code' => 400, 'description' => 'Phone number is in the blacklist.'], + ['code' => 'isv.PRODUCT_UNSUBSCRIBE', 'message' => 'The product has not been activated.', 'http_code' => 400, 'description' => 'Product is unsubscribed.'], + ['code' => 'isv.PRODUCT_UN_SUBSCRIPT', 'message' => 'Cloud Communications have not been enabled for the account.', 'http_code' => 400, 'description' => 'Your account is unsubscripted the Alibaba cloud communication.'], + ['code' => 'isv.RAM_CHECK_FAILED', 'message' => 'RAM authentication failed.', 'http_code' => 400, 'description' => 'Check ram premission failed.'], + ['code' => 'isv.TEMPLATE_ILLEGAL', 'message' => 'The template is invalid or does not exist.', 'http_code' => 400, 'description' => 'Template is illegal or non-existent.'], + ['code' => 'isv.TEMPLATE_MISSING_PARAMETERS', 'message' => 'Template parameters are missing.', 'http_code' => 400, 'description' => 'Template parameters are missing.'], + ['code' => 'isv.TEMPLATE_MISSING_PARAMETERS', 'message' => 'TTS template parameters are required.', 'http_code' => 400, 'description' => 'Missing the TTS template parammeters.'], + ['code' => 'isv.TEMPLATE_PARAMS_ILLEGAL', 'message' => 'Invalid template variable.', 'http_code' => 400, 'description' => 'Template param is illegal.'], + ['code' => 'isv.TTS_TEMPLATE_ILLEGAL', 'message' => 'Invalid TTS template.', 'http_code' => 400, 'description' => 'TTS template is illegal.'], + ['code' => 'isv.VOICE_CALL_FAIL', 'message' => 'Voice call failed.', 'http_code' => 400, 'description' => 'Voice call failed.'], + ['code' => 'isv.VOICE_CALL_PERIOD_ERROR', 'message' => 'Failed to obtain voice call periods.', 'http_code' => 400, 'description' => 'Get voice call period error.'], + ['code' => 'isv.VOICE_CODE_PARAM_ILLEGAL', 'message' => 'The voice code parameter is invalid.', 'http_code' => 400, 'description' => 'Voice code param is illegal.'], + ['code' => 'isv.VOICE_FILE_ILLEGAL', 'message' => 'Invalid voice file.', 'http_code' => 400, 'description' => 'Voice file is illegal.'], + ['code' => 'isv.VOICE_ROBOT_CALLEE_LIMIT', 'message' => 'A maximum of 1,000 callee numbers are allowed.', 'http_code' => 400, 'description' => 'Callee numbers limit 1,000.'], + ['code' => 'isv.VOICE_ROBOT_ID_NULL', 'message' => 'The voice robot is not found.', 'http_code' => 400, 'description' => 'Voice robotID is null.'], + ['code' => 'isv.VOICE_ROBOT_NOT_AUDIT', 'message' => 'The voice robot failed to pass the review.', 'http_code' => 400, 'description' => 'Voice robot is not audited.'], + ['code' => 'isv.VOICE_ROBOT_NOT_PERIOD', 'message' => 'The message sending time cannot be within the limit period.', 'http_code' => 400, 'description' => 'Sending voice message time cannot be within the limit period.'], + ['code' => 'Mobile.Invalid', 'message' => 'The mobile number is invalid.', 'http_code' => 400, 'description' => 'The specified mobile phone number is invalid.'], + ['code' => 'MobileVerifyCode.Invalid', 'message' => 'The mobile verification code is invalid.', 'http_code' => 400, 'description' => 'The specified mobile verification code is invalid.'], + ['code' => 'Query.Voice.File.Limit', 'message' => 'Voice file query number cannot exceed 10', 'http_code' => 400, 'description' => 'You can query up to ten audio files.'], + ['code' => 'RecordData.Query.Fail', 'message' => 'Failed to query records.', 'http_code' => 500, 'description' => 'Failed to query the record.'], + ['code' => 'REGISTER_400_QUALIFICATION_NOT_EXIS', 'message' => '400 qualification is not under the current customer or is invalid.', 'http_code' => 400, 'description' => '400 qualification is not under the current customer or is invalid.'], + ['code' => 'REGISTER_400_QUALIFICATION_NOT_EXIST_ERROR', 'message' => '400 qualification not exist or valid under custId.', 'http_code' => 400, 'description' => 'The 400 qualification does not exist or does not belong to the current account.'], + ['code' => 'STOCK_UNKNOWN_ERROR', 'message' => 'System exception.', 'http_code' => 400, 'description' => 'System exception'], + ['code' => 'UnauthorizedOperation', 'message' => 'You have not been authorized.', 'http_code' => 400, 'description' => 'You are not authorized to perform this operation.'], + ['code' => 'User.Query.Fail', 'message' => 'Failed to query user information.', 'http_code' => 500, 'description' => 'Failed to query the user information.'], + ['code' => 'VirtualNumber.NotOwn', 'message' => 'You can only use your own virtual number.', 'http_code' => 400, 'description' => ''], + ['code' => 'VirtualNumber.Query.Fail', 'message' => 'Failed to query virtual numbers.', 'http_code' => 500, 'description' => 'Failed to query the virtual number.'], + ], + 'changeSet' => [ [ - 'regionId' => 'cn-shenzhen-inner', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SmartCall'], + ], + 'createdAt' => '2024-04-18T02:28:58.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen-st4-d01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'QueryVirtualNumberRelation'], + ], + 'createdAt' => '2023-07-18T02:51:04.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen-su18-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CancelRobotTask'], + ], + 'createdAt' => '2022-12-06T11:07:06.000Z', + 'description' => '修改文档参数', ], [ - 'regionId' => 'cn-wuhan', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'IvrCall'], + ], + 'createdAt' => '2022-11-15T01:59:10.000Z', + 'description' => 'MenuKeyMap设置为文档必填', ], [ - 'regionId' => 'cn-yushanfang', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SingleCallByTts'], + ], + 'createdAt' => '2022-06-22T12:04:07.000Z', + 'description' => 'CalledShowNumber修改为文档非必填字段', ], [ - 'regionId' => 'cn-zhangbei-na61-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SingleCallByVoice'], + ], + 'createdAt' => '2022-04-29T10:04:01.000Z', + 'description' => '文档修改', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'RecoverCallInConfig'], + ['description' => 'OpenAPI offline', 'api' => 'StopCallInConfig'], + ], + 'createdAt' => '2022-04-20T06:14:15.000Z', + 'description' => 'Add OpenAPI.', ], [ - 'regionId' => 'cn-zhangjiakou-na62-a01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetToken'], + ], + 'createdAt' => '2022-03-01T16:04:46.000Z', + 'description' => '更新错误码', ], [ - 'regionId' => 'cn-zhengzhou-nebula-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateCallTask'], + ['description' => 'Error codes changed', 'api' => 'ListCallTask'], + ['description' => 'Error codes changed', 'api' => 'QueryVirtualNumber'], + ['description' => 'Error codes changed', 'api' => 'QueryVirtualNumberRelation'], + ], + 'createdAt' => '2022-02-16T06:52:55.000Z', + 'description' => '更新错误码', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'QueryVoiceFileAuditInfo'], + ], + 'createdAt' => '2022-01-21T07:28:55.000Z', + 'description' => 'Add QueryVoiceFileAuditInfo OpenAPI.', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryVoiceFileAuditInfo'], + ], + 'createdAt' => '2022-01-20T05:15:08.000Z', + 'description' => '新增查询语音文件审核状态接口', ], [ - 'regionId' => 'eu-west-1-oxs', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetHotlineQualificationByOrder'], + ['description' => 'Error codes changed', 'api' => 'SendVerification'], + ['description' => 'Error codes changed', 'api' => 'SubmitHotlineTransferRegister'], + ], + 'createdAt' => '2021-12-28T04:33:32.000Z', + 'description' => '增加错误码', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetMqttToken'], + ['description' => 'OpenAPI offline', 'api' => 'RefreshMqttToken'], + ], + 'createdAt' => '2021-11-18T05:39:55.000Z', + 'description' => '添加2个新api', ], [ - 'regionId' => 'rus-west-1-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetCallInfo'], + ], + 'createdAt' => '2021-08-20T03:34:06.000Z', + 'description' => 'add GetCallInfo', ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInTransferRecord'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DegradeVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PlayVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByTaskId'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVideo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotv2AllList'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByTts'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotInfoList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteCallTask'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IvrCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotlineTransferRegister'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineQualificationByOrder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelOrderRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetTransferCalleePoolConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadRobotTaskCalledFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCallOperate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotlineTransferRegisterFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemporaryFileUrl'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendVerification'], + ['threshold' => '1200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVoice'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddVirtualNumberRelation'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVirtualNumberRelation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTaskDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRobotTask'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByCallId'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVoiceFileAuditInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchRobotSmartCall'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetToken'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallMediaType'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInPoolTransferConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVideoPlayProgress'], ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'product' => ['code' => 'dyvms', 'title' => 'Dyvmsapi'], + ], + 'ram' => [ + 'productCode' => 'VoiceMessagingService', + 'productName' => 'Voice Service', + 'ramCodes' => ['dyvms'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DegradeVideoFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:DegradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SmartCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelOrderRobotTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelOrderRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotlineQualificationByOrder', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetHotlineQualificationByOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitHotlineTransferRegister', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SubmitHotlineTransferRegister', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetTransferCalleePoolConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SetTransferCalleePoolConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallInTransferRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInTransferRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchRobotSmartCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:BatchRobotSmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallDetailByCallId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByCallId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryVirtualNumberRelation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskCallDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallDetailByTaskId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByTaskId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRobotTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PauseVideoFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PauseVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryVideoPlayProgress', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:QueryVideoPlayProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:CancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartRobotTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StartRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotv2AllList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotv2AllList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SmartCallOperate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCallOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListHotlineTransferRegisterFile', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:ListHotlineTransferRegisterFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryVoiceFileAuditInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVoiceFileAuditInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopRobotTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StopRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpgradeVideoFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:UpgradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'IvrCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:IvrCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecuteCallTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:ExecuteCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallInPoolTransferConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInPoolTransferConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCallTask', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRobotTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dyvms:DeleteRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SingleCallByVideo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResumeVideoFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:ResumeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SendVerification', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SendVerification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotInfoList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskCallList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelRobotTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddVirtualNumberRelation', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:AddVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UploadRobotTaskCalledFile', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:UploadRobotTaskCalledFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PlayVideoFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PlayVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCallTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SingleCallByTts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByTts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SingleCallByVoice', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetToken', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCallTaskDetail', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SkipVideoFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SkipVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; -- cgit v1.2.3