diff options
Diffstat (limited to 'data/en_us/dyvmsapi/2017-05-25/api-docs.php')
| -rw-r--r-- | data/en_us/dyvmsapi/2017-05-25/api-docs.php | 7746 |
1 files changed, 7746 insertions, 0 deletions
diff --git a/data/en_us/dyvmsapi/2017-05-25/api-docs.php b/data/en_us/dyvmsapi/2017-05-25/api-docs.php new file mode 100644 index 0000000..4d23dc6 --- /dev/null +++ b/data/en_us/dyvmsapi/2017-05-25/api-docs.php @@ -0,0 +1,7746 @@ +<?php return [ + 'version' => '1.0', + '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', + ], + ], + [ + 'id' => 141333, + 'title' => 'Intelligent Voice Robot', + 'type' => 'directory', + 'children' => [ + 'CreateRobotTask', + 'BatchRobotSmartCall', + 'StartRobotTask', + 'StopRobotTask', + 'CancelOrderRobotTask', + 'CancelRobotTask', + 'DeleteRobotTask', + 'QueryRobotv2AllList', + 'QueryRobotTaskList', + 'QueryCallDetailByTaskId', + 'QueryRobotTaskDetail', + 'QueryRobotTaskCallList', + 'QueryRobotInfoList', + 'QueryRobotTaskCallDetail', + 'UploadRobotTaskCalledFile', + ], + ], + [ + 'id' => 141349, + 'title' => 'The China 400 Number', + 'type' => 'directory', + 'children' => [ + 'GetHotlineQualificationByOrder', + 'ListHotlineTransferRegisterFile', + 'SubmitHotlineTransferRegister', + 'SetTransferCalleePoolConfig', + 'QueryCallInPoolTransferConfig', + 'QueryCallInTransferRecord', + 'SendVerification', + ], + ], + [ + 'id' => 191750, + 'title' => '5G video call (invitation system)', + 'type' => 'directory', + 'children' => [ + 'SingleCallByVideo', + 'PlayVideoFile', + 'PauseVideoFile', + 'ResumeVideoFile', + 'QueryVideoPlayProgress', + 'UpgradeVideoFile', + 'DegradeVideoFile', + 'SkipVideoFile', + 'GetCallMediaType', + 'GetTemporaryFileUrl', + ], + ], + [ + 'id' => 141358, + 'title' => 'Obtains the Token for Authentication', + 'type' => 'directory', + 'children' => [ + 'GetToken', + ], + ], + [ + 'id' => 166959, + 'title' => 'Setting a China 400 Number', + 'type' => 'directory', + 'children' => [ + 'RecoverCallInConfig', + 'StopCallInConfig', + ], + ], + [ + 'id' => 362618, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CancelCall', + 'QueryVmsVirtualNumberRelationByPage', + 'QueryVmsRealNumberCallConnectionRateInfo', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + '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', + ], + ], + [ + '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', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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****', + ], + ], + ], + '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' => '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****', + ], + ], + ], + ], + ], + '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' => ' ', + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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_100****', + ], + ], + [ + '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"}', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => 'The playback speed. Valid value: -500 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + '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*****', + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + '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' => ' ', + ], + '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' => 'Aliyun', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TTS_2122****', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test Template', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The calling number. Only virtual numbers are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '05516214****', + ], + ], + [ + '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', + ], + ], + [ + '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":["name1","name2","key3"], "calleeList":[ { "callee":"131222222", "params":["zangsan","zhangsan01","zhangsan02"] }, { "callee":"131222222", "params":["zangsan","zhangsan01","zhangsan02"] }, ] }', + ], + ], + [ + 'name' => 'FireTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StopTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScheduleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The 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":"<CreateCallTaskResponse>\\n <Code>200</Code>\\n <Data>123456</Data>\\n <RequestId>ED815433-724A-4357-9991-A54AD2FF09FD</RequestId>\\n</CreateCallTaskResponse>","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", + ], + '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', + ], + ], + [ + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test Template', + ], + ], + [ + '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' => 'DONE', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '151001****', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The 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":"<ListCallTaskResponse>\\n <RequestId>5B0F201F-DCDA-45C2-AA92-1AE177F94991</RequestId>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>20</Total>\\n <Data>\\n <Status>DONE</Status>\\n <FireTime>1614330978000</FireTime>\\n <Resource>05516214****</Resource>\\n <BizType>VMS_VOICE_TTS</BizType>\\n <Data>0fec3add-ef76-4c24-9728-666ababae9d6--alicomTask.xlsx</Data>\\n <CompletedCount>1</CompletedCount>\\n <TemplateCode>TTS_21194****</TemplateCode>\\n <TotalCount>1</TotalCount>\\n <TaskName>测试任务</TaskName>\\n <CompletedRate>10000</CompletedRate>\\n <TemplateName>特服号码测试模板</TemplateName>\\n <DataType>LIST</DataType>\\n <Id>1951001</Id>\\n <CompleteTime>1614330986000</CompleteTime>\\n </Data>\\n <Data>\\n <Status>DONE</Status>\\n <FireTime>1614159414000</FireTime>\\n <Resource>05516214****</Resource>\\n <BizType>VMS_VOICE_TTS</BizType>\\n <Data>dyvms_51bae600-1e0c-4f65-9fb5-5811fd2226b7.xlsx</Data>\\n <CompletedCount>2</CompletedCount>\\n <TemplateCode>TTS_21194****</TemplateCode>\\n <TotalCount>2</TotalCount>\\n <TaskName>任务中心</TaskName>\\n <CompletedRate>10000</CompletedRate>\\n <TemplateName>特服号码测试模板</TemplateName>\\n <DataType>FILE</DataType>\\n <Id>195002</Id>\\n <CompleteTime>1614159424000</CompleteTime>\\n </Data>\\n <Code>200</Code>\\n</ListCallTaskResponse>","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' => ' ', + ], + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The 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":"<ExecuteCallTaskResponse>\\n <Code>200</Code>\\n <Data>true</Data>\\n <RequestId>53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD</RequestId>\\n</ExecuteCallTaskResponse>","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' => ' ', + ], + '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' => '150001****', + ], + ], + [ + 'name' => 'CalledNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The called number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1300000****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<ListCallTaskDetailResponse>\\n <RequestId>7C943A5D-E12A-4184-A5F8-CF57B92815E3</RequestId>\\n <TotalPage>500</TotalPage>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>1000</Total>\\n <Data>\\n <Status>FAIL</Status>\\n <Caller>05516214****</Caller>\\n <Duration>0</Duration>\\n <CalledNum>1300001****</CalledNum>\\n </Data>\\n <Data>\\n <Status>FAIL</Status>\\n <Caller>05516214****</Caller>\\n <Duration>0</Duration>\\n <CalledNum>1310000****</CalledNum>\\n </Data>\\n <Code>OK</Code>\\n</ListCallTaskDetailResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '52666', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsT3BNLH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service name. Default value: **dyvms**.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'dyvms', + 'default' => 'dyvmsapi', + ], + ], + [ + 'name' => 'CorpNameList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The company names. Separate multiple company names with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Company 1', + ], + ], + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The real numbers. Separate multiple real numbers with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1321111****,1322222****', + ], + ], + [ + 'name' => 'RouteType', + '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', + ], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '05516214****', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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":"<AddVirtualNumberRelationResponse>\\n<RequestId>B0411112-6CF8-4752-81D1-918A1354AE49</RequestId>\\n<Message>successful</Message>\\n<Data>1321111*****</Data>\\n<Code>200</Code>\\n</AddVirtualNumberRelationResponse>","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' => ' ', + ], + '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', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '20', + ], + ], + [ + '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', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'RegionNameCity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The city to which the virtual number belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'RelatedNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The real number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1705559****', + ], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '05516214****', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'VirtualNumber.NotOwn', + 'errorMessage' => 'You can only use your own virtual number.', + ], + ], + ], + '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":"<QueryVirtualNumberRelationResponse>\\n<RequestId>8FAD5988-B483-48A4-B251-6E8470A67371</RequestId>\\n<Data>\\n <data>\\n <relatedNum>1705559****</relatedNum>\\n <createTime>2021-03-26 12:34:08</createTime>\\n </data>\\n <pageSize>20</pageSize>\\n <total>1</total>\\n <pageNo>1</pageNo>\\n</Data>\\n<Code>200</Code>\\n</QueryVirtualNumberRelationResponse>","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' => ' ', + ], + 'ListServiceInstanceForPage' => [ + 'summary' => '分页查询服务实例列表', + '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' => [ + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '用途ID', + 'description' => '用途ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '89', + ], + ], + [ + 'name' => 'RelationNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '关联实体号码', + 'description' => '关联实体号码', + 'type' => 'string', + 'required' => false, + 'example' => '131****1111', + ], + ], + [ + 'name' => 'Pager', + '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' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + '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' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '状态码，OK表示响应成功', + 'description' => '状态码，OK表示响应成功', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + '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', + ], + ], + [ + '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' => [], + ], + ], + ], + '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', + ], + ], + ], + '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' => [], + ], + ], + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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' => '1671552000000', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<QueryCallDetailByCallIdResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\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****\\"}</Data>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n</QueryCallDetailByCallIdResponse>","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' => [], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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****', + ], + ], + [ + '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"}', + ], + ], + [ + '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', + ], + ], + [ + '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****', + ], + ], + [ + '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"} ', + ], + ], + [ + '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', + ], + ], + [ + '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****', + ], + ], + [ + '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', + ], + '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****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 15, + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52713', + 'abilityTreeNodes' => [ + 'FEATUREdyvms59DC26', + ], + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + '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', + ], + ], + [ + 'name' => 'CalledNumber', + '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', + ], + ], + [ + 'name' => 'VoiceCode', + '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$', + ], + ], + [ + 'name' => 'RecordFlag', + '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', + ], + ], + [ + 'name' => 'ActionCodeBreak', + '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', + ], + ], + [ + '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' => '342268*****', + ], + ], + [ + 'name' => 'DynamicId', + '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', + ], + ], + [ + 'name' => 'EarlyMediaAsr', + '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', + ], + ], + [ + 'name' => 'VoiceCodeParam', + '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"}', + ], + ], + [ + 'name' => 'SessionTimeout', + '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', + ], + ], + [ + 'name' => 'ActionCodeTimeBreak', + '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', + ], + ], + [ + 'name' => 'TtsStyle', + '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', + ], + ], + [ + 'name' => 'TtsVolume', + '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', + ], + ], + [ + 'name' => 'TtsSpeed', + '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', + ], + ], + [ + 'name' => 'TtsConf', + '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', + ], + ], + [ + 'name' => 'AsrBaseId', + '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', + ], + ], + [ + 'name' => 'StreamAsr', + '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', + ], + ], + [ + 'name' => 'BackgroundFileCode', + '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', + ], + ], + [ + 'name' => 'BackgroundVolume', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4', + 'minimum' => '-4', + 'example' => '1', + ], + ], + [ + 'name' => 'BackgroundSpeed', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EnableITN', + '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', + ], + ], + [ + 'name' => 'NoiseThreshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + '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":"<SmartCallResponse>\\n<Message>OK</Message>\\n<RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n<CallId>116012854210^10281427****</CallId>\\n<Code>OK</Code>\\n</SmartCallResponse>","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', + ], + '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****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Param', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<SmartCallOperateResponse>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\r\\n\\t<Status>true</Status>\\r\\n</SmartCallOperateResponse>","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' => [], + ], + ], + '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' => 'Test Template', + ], + ], + [ + '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****', + ], + ], + [ + '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' => 'Alibaba', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'RecallTimes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of redial times.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + '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', + ], + ], + [ + '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' => 'Alibaba', + ], + ], + [ + 'name' => 'CalledNumber', + '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****', + ], + ], + [ + 'name' => 'DialogId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'EarlyMediaAsr', + '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', + ], + ], + [ + '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, + 'example' => 'Batch Tasks', + ], + ], + [ + 'name' => 'ScheduleTime', + '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', + ], + ], + [ + 'name' => 'ScheduleCall', + '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', + ], + ], + [ + 'name' => 'TtsParam', + '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"]}]', + ], + ], + [ + '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"]', + ], + ], + [ + 'name' => 'IsSelfLine', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to call the self-managed line. Default value: **false**.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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****', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<StartRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</StartRobotTaskResponse>","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', + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<StopRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</StopRobotTaskResponse>","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', + ], + 'security' => [ + [ + '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 ID of the robocall task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1045001', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<CancelOrderRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</CancelOrderRobotTaskResponse>","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', + ], + 'security' => [ + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<DeleteRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<TaskId>4001112222</TaskId>\\n</DeleteRobotTaskResponse>","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' => [], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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":"<QueryRobotv2AllListResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>{\\"id\\":100000007****,\\"robotName\\":\\"机器人\\",\\"robotType\\":\\"CUSTOM\\"}</Data>\\n</QueryRobotv2AllListResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test Template', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<QueryRobotTaskListResponse>\\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} ]</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <PageNo>1</PageNo>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <PageSize>1</PageSize>\\n <TotalCount>1</TotalCount>\\n</QueryRobotTaskListResponse>","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' => [], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<QueryCallDetailByTaskIdResponse>\\r\\n \\t<Data>{"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}</Data>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>D86B61A8-F2EE-4E4C-9F05-08A4676FFD89</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QueryCallDetailByTaskIdResponse>","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' => [], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":"<QueryRobotTaskDetailResponse>\\n<Data>\\n <caller>0571568xxxx,0571568xxxx</caller>\\n <createTime>2019-06-14 11:04:19</createTime>\\n <status>INIT</status>\\n <retryType>1</retryType>\\n <taskName>智能语音务</taskName>\\n <robotName>机器人</robotName>\\n <id>1045001</id>\\n <numberStatusIdent>true</numberStatusIdent>\\n <scheduleType>SINGLE</scheduleType>\\n <corpName>xx公司 </corpName>\\n <recallTimes>2</recallTimes>\\n <fireTime>2019-06-14 11:05:23</fireTime>\\n <robotId>1000000075003</robotId>\\n <called>\\n <ossFilePath>http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx</ossFilePath>\\n <fileName>5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi</fileName>\\n </called>\\n <recallInterval>5</recallInterval>\\n <recallStateCodes>200010,200011</recallStateCodes>\\n <completeTime>2019-06-14 18:21:06</completeTime>\\n</Data>\\n<Message>OK</Message>\\n<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n<Code>OK</Code>\\n</QueryRobotTaskDetailResponse>\\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' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'DurationFrom', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum call duration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'DurationTo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum call duration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'DialogCountFrom', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of conversation rounds in the call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'DialogCountTo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of conversation rounds in the call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Called', + 'in' => 'query', + 'schema' => [ + 'description' => 'The called number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1300****0000', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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":"<QueryRobotTaskCallListResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\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, “konwledgeCount” : 0, “defaultCount” : 0, “knowledgeBusinessCount” : 0, “knowledgeCommonCount” : 0 } ]</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n</QueryRobotTaskCallListResponse>","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' => ' ', + ], + '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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<QueryRobotInfoListResponse>\\r\\n\\t<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\\":\\"催收场景-ssml标记2-RVR\\"}}]</Data>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>E8EF9B41-C4DC-44D5-A25B-DA9AC7791998</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QueryRobotInfoListResponse>","errorExample":""}]', + 'title' => 'QueryRobotInfoList', + 'summary' => 'Queries a list of robots to obtain their details.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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', + ], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => [ + 'description' => 'The called number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '130****0000', + ], + ], + [ + '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' => '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', + ], + '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', + ], + ], + ], + ], + ], + '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":"<QueryRobotTaskCallDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\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, \\"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\\":\\"开场白\\"}] }</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n</QueryRobotTaskCallDetailResponse>","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', + ], + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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":["xiaowang","xiaoli","xiaozhou"]}]', + ], + ], + [ + '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"]', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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":"<UploadRobotTaskCalledFileResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>10450****</Data>\\n</UploadRobotTaskCalledFileResponse>","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', + ], + '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' => '22456****', + ], + ], + ], + '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', + ], + '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****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal server error occurred.', + ], + ], + ], + '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":"<GetHotlineQualificationByOrderResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>6086693B-2250-17CE-A41F-06259AB6DB1B</RequestId>\\n <Data>\\n <Status>NORMA</Status>\\n <QualificationId>1478*****</QualificationId>\\n <OrderId>22456****</OrderId>\\n </Data>\\n</GetHotlineQualificationByOrderResponse>","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", + ], + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'HotlineNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The China 400 number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '400****', + ], + ], + ], + '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', + ], + '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' => '[email protected]', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + ], + '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\\": \\"[email protected]\\",\\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' => ' ', + ], + '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****', + ], + '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, + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'OperatorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the handler.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'A***', + ], + ], + [ + 'name' => 'OperatorMail', + 'in' => 'query', + 'schema' => [ + 'description' => 'The email address of the handler.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'OperatorMobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number of the handler.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '158****7230', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'OperatorIdentityCard', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID card number of the handler.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5****************9', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'HotlineNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The China 400 number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '400****', + ], + ], + ], + '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 registration ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2258****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => ' ', + ], + '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', + ], + 'Called' => [ + 'description' => 'The called number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '151****0000', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number used for transferring the call.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '400****', + ], + ], + [ + '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***', + ], + ], + [ + '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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + ], + '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' => ' ', + ], + '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' => '400****', + ], + ], + ], + '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', + ], + '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", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Called' => [ + 'description' => 'The number used to transfer the call.'."\n", + 'type' => 'string', + 'example' => '400****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<QueryCallInPoolTransferConfigResponse>\\n<Message>OK</Message>\\n<RequestId>7BF47617-7851-48F7-A3A1-2021342A78E2</RequestId>\\n<Data>\\n <GmtCreate>1623137002000</GmtCreate>\\n <CalledRouteMode>random</CalledRouteMode>\\n <TransferTimeout>30</TransferTimeout>\\n <Details>\\n <Called>400****</Called>\\n </Details>\\n</Data>\\n<Code>OK</Code>\\n</QueryCallInPoolTransferConfigResponse>","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', + ], + '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****', + ], + ], + [ + 'name' => 'CallInCaller', + 'in' => 'query', + 'schema' => [ + 'description' => 'The calling number of the inbound call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '150****0000', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + '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', + ], + 'Total' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"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":"<QueryCallInTransferRecordResponse>\\n<Message>OK</Message>\\n<RequestId>7BF47617-7851-48F7-A3A1-2021342A78E2</RequestId>\\n<Data>\\n <PageSize>20</PageSize>\\n <Total>50</Total>\\n <PageNo>1</PageNo>\\n <Values>\\n <GmtCreate>1624865503000</GmtCreate>\\n <CallInCalled>150****0000</CallInCalled>\\n <RecordUrl>http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684eea0.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73PsLI&Signature=****mUqkPqIQ%3D</RecordUrl>\\n <TransferCaller>151****0000</TransferCaller>\\n <TransferCalled>151****0000</TransferCalled>\\n <CallInCaller>150****0000</CallInCaller>\\n </Values>\\n</Data>\\n<Code>OK</Code>\\n</QueryCallInTransferRecordResponse>","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' => ' ', + ], + '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', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business type. Set the value to **CONTACT**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CONTACT', + ], + ], + [ + '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', + ], + ], + ], + '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 verification code was sent successfully.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', + ], + ], + ], + ], + ], + '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', + ], + '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":"<SendVerificationResponse>\\n<Message>OK</Message>\\n<RequestId>6086693B-2250-17CE-A41F-06259AB6DB1B</RequestId>\\n<Data>true</Data>\\n<Code>OK</Code>\\n</SendVerificationResponse>","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' => ' ', + ], + 'SingleCallByVideo' => [ + 'summary' => 'Sends voice file notifications or video file notifications to a single called number.', + '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' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '0571****5678', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1590****000', + ], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', + ], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefgh', + ], + ], + [ + 'name' => 'VideoCode', + 'in' => 'query', + 'schema' => [ + 'title' => '视频文件', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + '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****', + ], + ], + ], + ], + ], + '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' => 'SingleCallByVideo', + ], + 'PlayVideoFile' => [ + 'summary' => 'Plays back 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' => [ + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '116012354148^1028137841****', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '342268*****', + ], + ], + [ + 'name' => 'OnlyPhone', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Model' => [ + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201533', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsRK85FW', + ], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '116012854210^10281427****', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201535', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsRK85FW', + ], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '100001616500^1000018****', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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', + ], + 'QueryVideoPlayProgress' => [ + 'summary' => 'Queries the video playback progress after you play a video file during 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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '116004767703^102806****', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '159****0000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '217976', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsL1CC4Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '116012354148^10281378****', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + 'default' => 'VIDEO', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '225869*****', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1590****000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '217975', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsL1CC4Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '116012354148^1028137841****', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + 'default' => 'AUDIO', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '225869*****', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1590****000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '218113', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsL1CC4Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '116012854210^10281427****', + ], + ], + [ + 'name' => 'SkipTimes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '04:02:01', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PR0210428****', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1590****000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '116012854210^10281427****', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1580000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => 'GetCallMediaType', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '45a04670582571eebf9e4531948c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7BF47617-7851-48F7-A3A1-2021342A****', + ], + 'Data' => [ + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => 'GetTemporaryFileUrl', + ], + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + ], + '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":"<GetTokenResponse>\\n<Message>OK</Message>\\n<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD</RequestId>\\n<Token>eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZiI6MTYyMzM5NDQ2Ny****</Token>\\n<Code>OK</Code>\\n<Success>true</Success>\\n</GetTokenResponse>","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' => ' ', + ], + '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***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainApiResponse<Boolean>', + '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', + ], + '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.', + ], + ], + ], + '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.', + ], + '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***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainApiResponse<Boolean>', + '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', + ], + '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.', + ], + ], + ], + '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.', + ], + 'CancelCall' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '116012854210^10281427****', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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":"<CancelCallResponse>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\r\\n\\t<Status>true</Status>\\r\\n</CancelCallResponse>","errorExample":""}]', + 'title' => 'CancelCall', + 'summary' => 'Cancels the two-way call that is initiated by calling the ClickToDial operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryVmsVirtualNumberRelationByPage' => [ + 'summary' => '查询虚拟号码与真实号码绑定关系列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '81', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '74', + ], + ], + [ + 'name' => 'VirtualNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '虚拟号码', + 'description' => '虚拟号码', + 'type' => 'string', + 'required' => false, + 'example' => '0571****1234', + ], + ], + [ + 'name' => 'RealNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '真实号码', + 'description' => '真实号码', + 'type' => 'string', + 'required' => false, + 'example' => '131***1234', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'title' => '状态 1:有效；0:无效；-1:注销', + 'description' => '状态 1:有效；0:无效；-1:注销', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NumberCity', + 'in' => 'query', + 'schema' => [ + 'title' => '号码归属地--城市', + 'description' => '号码归属地--城市', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'NumberProvince', + 'in' => 'query', + 'schema' => [ + 'title' => '号码归属地--省', + 'description' => '号码归属地--省', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '65', + ], + 'Total' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '231', + ], + 'PageNo' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + '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' => '示例值示例值', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'QueryVmsRealNumberCallConnectionRateInfo' => [ + 'summary' => '查询真实号接通率', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'VirtualNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '虚拟号码', + 'description' => '虚拟号码', + 'type' => 'string', + 'required' => false, + 'example' => '0571***1234', + ], + ], + [ + 'name' => 'RealNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '真实号码', + 'description' => '真实号码', + 'type' => 'string', + 'required' => false, + 'example' => '131***1234', + ], + ], + [ + 'name' => 'TimePeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '时间段', + 'description' => '时间段', + 'type' => 'string', + 'required' => false, + 'example' => '1764666240123-1764686240567', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + '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' => [ + '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' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + ], + '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', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + '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', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'dyvmsapi.aliyuncs.com', + ], + ], +]; |