diff options
Diffstat (limited to 'data/en_us/dyvmsapi-intl')
| -rw-r--r-- | data/en_us/dyvmsapi-intl/2021-10-15/api-docs.php | 1327 |
1 files changed, 1327 insertions, 0 deletions
diff --git a/data/en_us/dyvmsapi-intl/2021-10-15/api-docs.php b/data/en_us/dyvmsapi-intl/2021-10-15/api-docs.php new file mode 100644 index 0000000..3375682 --- /dev/null +++ b/data/en_us/dyvmsapi-intl/2021-10-15/api-docs.php @@ -0,0 +1,1327 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dyvmsapi-intl', + 'version' => '2021-10-15', + ], + 'directories' => [ + [ + 'id' => 186730, + 'title' => 'Voice Single Call', + 'type' => 'directory', + 'children' => [ + 'VoiceSingleCall', + ], + ], + [ + 'id' => 166271, + 'title' => 'Voice group call', + 'type' => 'directory', + 'children' => [ + 'VoiceGroupCall', + ], + ], + [ + 'id' => 200087, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'BackendCallGroup', + 'BackendCallSignal', + 'SignalCall', + 'GroupCall', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'VoiceSingleCall' => [ + 'summary' => 'Sends a voice verification code or voice notification with variables to a phone number. A voice file or text-to-speech (TTS) template is supported.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '258913', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsF61Y5H', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CallerIdNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and go to the number management page to view the purchased phone numbers.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****0001', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number that receives the voice notification. You must add the country/region dialing code to the beginning of the phone number. Example: 85200\\*\\*\\*\\*00.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****0000', + ], + ], + [ + 'name' => 'TtsCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the TTS template. You can log on to the VMS console and go to the TTS templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables in the template, in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234"}', + ], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the voice file template. You can log on to the VMS console and go to the voice file templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1002', + ], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of times the voice notification is played in the call. Valid values: 1 to 3. Default value: 3.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + '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' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => 'The playback speed. Valid values: -500 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Task0', + ], + ], + [ + 'name' => 'SendType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The delivery type. Valid values: 1 and 2. 1: immediately delivers the task. 2: delivers the task at a scheduled time. If you set this parameter to 2, you must specify TimingStart.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TimingStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the task is scheduled to be delivered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-05-01T08:00:00+08:00', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be a string that is 1 to 15 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '22522****', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ISO2 country/region code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D9CB****-****-****-****-********9D23'."\n", + ], + 'Model' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + ], + 'Code' => [ + 'description' => 'The error code. A value of OK indicates that the request was successful. For information about other error codes, see Error codes.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB****-****-****-****-********9D23\\\\n\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'VoiceSingleCall', + ], + 'VoiceGroupCall' => [ + 'summary' => 'Sends a voice notification to multiple phone numbers. A voice file or text-to-speech (TTS) template is supported.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '258912', + 'abilityTreeNodes' => [ + 'FEATUREdyvmsRGAF50', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CallerIdNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and go to the number management page to view the purchased phone numbers.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****1111', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The called numbers. You can specify up to 50,000 numbers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The number. You must add the country/region dialing code to the beginning of the phone number. Example: 852\\*\\*\\*\\*0000.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****0000', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TtsCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the TTS template. You can log on to the VMS console and go to the TTS templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1****01', + ], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables in the template, in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234"}', + ], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the voice file template. You can log on to the VMS console and go to the voice file templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2*****01', + ], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of times the voice notification is played in the call. Valid values: 1 to 3.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => [ + 'description' => 'The playback volume of the voice file. Valid values: 0 to 100. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => 'The playback speed. Valid values: -500 to 500. This parameter is required when a TTS template is used. You do not need to specify this parameter when a recorded voice file is used.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'calltask', + ], + ], + [ + 'name' => 'SendType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The delivery type. Valid values: 1 and 2. 1: immediately delivers the task. 2: delivers the task at a scheduled time. If you set this parameter to 2, you must specify TimingStart.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TimingStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the task is scheduled to be delivered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-05-01T08:00:00+08:00', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be a string that is 1 to 15 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '22596****', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ISO2 country/region code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E50F****-****-****-****-********966F', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Model' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + ], + 'Code' => [ + 'description' => 'The error code. A value of OK indicates that the request was successful. For information about other error codes, see Error codes.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"E50F****-****-****-****-********966F\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'VoiceGroupCall', + ], + 'BackendCallGroup' => [ + 'summary' => 'Initiates a voice group call to multiple phone numbers. The content of the group call is that of approved templates. You can log on to the VMS console and choose Voice Call Template to view the template ID. This feature enqueues the phone numbers to be called. The time when the phone numbers are called is uncertain.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '107319', + 'abilityTreeNodes' => [ + 'FEATUREdyvms5W940Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The called numbers. You can specify up to 50,000 phone numbers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'You must add the country code to the beginning of the phone numbers. Example: 852\\*\\*\\*\\*0000.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****0000', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CallerIdNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The calling number.'."\n" + ."\n" + .'If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and choose Number Management to view the purchased phone numbers.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****1111', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ISO2 country code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HK', + ], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of times the audio file is played. Valid values: 1 to 3.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SendType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The delivery type. Valid values: 1 and 2.'."\n" + ."\n" + .'1: The audio file is delivered immediately.'."\n" + ."\n" + .'2: The audio file is delivered at a scheduled time. If you specify SendType as 2, you must specify TimingStart.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => 'The playback speed. Valid values: -500 to 500.'."\n" + ."\n" + .'You must specify this parameter when the audio type is text-to-speech (TTS). You do not need to specify this parameter when you use recordings.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TimingStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the audio file is scheduled to be delivered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-05-01T08:00:00+08:00', + ], + ], + [ + 'name' => 'TtsCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The voice template ID of the audio file.'."\n" + ."\n" + .'You can log on to the VMS console and choose Voice Call Template > Audio File to view the template ID.'."\n" + ."\n" + .'You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the audio file as the call content. Alternatively, you can specify VoiceCode to use preset text as the call content.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The TTS template ID.'."\n" + ."\n" + .'You can log on to the VMS console and choose Voice Call Template > TTS Template to view the template ID.'."\n" + ."\n" + .'You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the audio file as the call content. Alternatively, you can specify VoiceCode to use preset text as the call content.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '200001', + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => [ + 'description' => 'The playback volume of the audio file. Valid values: 0 to 100. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'title' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度为1~15个字节。', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E50FFA85-0B79-4421-A7BD-00B0A271966F', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'The value OK indicates that the request was successful. Other values indicate that the request failed. For more information, see Error codes.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'TaskId' => [ + 'description' => 'The task ID. You can use this ID to query the details of the task.'."\n", + 'type' => 'string', + 'example' => '550e8400-e29b-41d4-a716-446655440000', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E50F****-****-****-****-********966F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"TaskId\\": \\"550E****-****-****-****-********00A0\\"\\n}","errorExample":""},{"type":"xml","example":"<BackendCallGroupResponse>\\n <RequestId>E50FFA85-0B79-4421-A7BD-00B0A271966F</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <TaskId>550e8400-e29b-41d4-a716-446655440000</TaskId>\\n</BackendCallGroupResponse>","errorExample":""}]', + 'title' => 'BackendCallGroup', + ], + 'BackendCallSignal' => [ + 'summary' => 'Sends a voice verification code and voice notification with variables to a phone number.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '107320', + 'abilityTreeNodes' => [ + 'FEATUREdyvms5W940Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number that receives the voice notification.'."\n" + ."\n" + .'You must add the country code to the beginning of the phone number. Example: 85200\\*\\*\\*\\*00.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****0000', + ], + ], + [ + 'name' => 'CallerIdNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The calling number.'."\n" + ."\n" + .'If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and choose Number Management to view the purchased phone numbers.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '852****0000', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ISO2 country code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HK', + ], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of times the voice notification is played back in a call. Valid values: 1 to 3. Default value: 3.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => 'The playback speed. Valid values: -500 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TtsCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the approved voice verification code template.'."\n" + ."\n" + .'You can log on to the VMS console and choose Voice Call Template to view the template ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables in the template, in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234"}', + ], + ], + [ + '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' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'title' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度为1~15个字节。', + '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' => '22522****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'The value OK indicates that the request was successful. Other values indicate that the request failed. For more information, see Error codes.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'CallId' => [ + 'description' => 'The unique receipt ID for the call. You can use this ID to query the details of a single call.'."\n", + 'type' => 'string', + 'example' => '550e8400-e29b-41d4-a716-446655440000', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB****-****-****-****-********9D23\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"550E****-****-****-****-********0CA0\\"\\n}","type":"json"}]', + 'title' => 'BackendCallSignal', + ], + 'SignalCall' => [ + 'summary' => '向指定号码发送语音验证码和带参数变量的语音通知，支持语音文件模板或文本转语音模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'CallerIdNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '主叫号码。 若您不填该参数，系统将会使用当地随机号码作为外显号码。 若您专属号码外呼，则必须传入已购买的号码，仅支持一个号码。您可以登录国际语音服务控制台，选择"号码管理"查看已购买的号码。', + 'description' => '主叫号码。 若您不填该参数，系统将会使用当地随机号码作为外显号码。 若您专属号码外呼，则必须传入已购买的号码，仅支持一个号码。您可以登录国际语音服务控制台，选择"号码管理"查看已购买的号码。', + 'type' => 'string', + 'required' => false, + 'example' => '852****0001', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '接收语音通知的手机号码。 号码格式：国际码+号码： 示例：85200****00。', + 'description' => '接收语音通知的手机号码。 号码格式：国际码+号码： 示例：85200****00。', + 'type' => 'string', + 'required' => false, + 'example' => '852****0000', + ], + ], + [ + 'name' => 'TtsCode', + 'in' => 'query', + 'schema' => [ + 'title' => '文本转语音模板的语音ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"文本转语音模板"，查看模板ID。 此参数与VoiceCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'description' => '文本转语音模板的语音ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"文本转语音模板"，查看模板ID。 此参数与VoiceCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => [ + 'title' => '模板中的变量参数，JSON格式。', + 'description' => '模板中的变量参数，JSON格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234"}', + ], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => [ + 'title' => '语音文件的模板ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"语音文件"，查看模板ID。 此参数与TtsCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'description' => '语音文件的模板ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"语音文件"，查看模板ID。 此参数与TtsCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'type' => 'string', + 'required' => false, + 'example' => '1002', + ], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => [ + 'title' => '一通电话内语音通知内容的播放次数。取值范围：1~3，默认取值3。', + 'description' => '一通电话内语音通知内容的播放次数。取值范围：1~3，默认取值3。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => [ + 'title' => '语音通知的播放音量。取值范围：0~100，默认取值100。', + 'description' => '语音通知的播放音量。取值范围：0~100，默认取值100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'title' => '语速控制。取值范围为：-500~500。', + 'description' => '语速控制。取值范围为：-500~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'title' => '国家/地区二字码，ISO2。', + 'description' => '国家/地区二字码，ISO2。', + 'type' => 'string', + 'required' => false, + 'example' => 'HK', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '任务名称。', + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => '单呼任务名', + ], + ], + [ + 'name' => 'SendType', + 'in' => 'query', + 'schema' => [ + 'title' => '发送类型：取值[1,2]。 1： 立即开始发送任务，不等待。 2： 定时开始发送任务。如果传该类型，TimingStart为必选字段。', + 'description' => '发送类型：取值[1,2]。 1： 立即开始发送任务，不等待。 2： 定时开始发送任务。如果传该类型，TimingStart为必选字段。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TimingStart', + 'in' => 'query', + 'schema' => [ + 'title' => '定时发送的时间。', + 'description' => '定时发送的时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-05-01T08:00:00+08:00', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'title' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。 字符串类型，长度为1~15个字节。', + 'description' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。 字符串类型，长度为1~15个字节。', + 'type' => 'string', + 'required' => false, + 'example' => '22522****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D9CB****-****-****-****-********9D23'."\n", + ], + 'Message' => [ + 'title' => '返回信息描述。', + 'description' => '返回信息描述。', + 'type' => 'string', + 'example' => 'OK'."\n", + ], + 'Model' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CallId' => [ + 'title' => '任务ID，可以通过此ID查询任务的详情。', + 'description' => '任务ID，可以通过此ID查询任务的详情。', + 'type' => 'string', + 'example' => '550E****-****-****-****-********0CA0'."\n", + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '请求状态码。 返回OK代表请求成功。 其他错误码，请参见API错误码。', + 'description' => '请求状态码。 返回OK代表请求成功。 其他错误码，请参见API错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '请求是否成功，成功：true，失败：false。', + 'description' => '请求是否成功，成功：true，失败：false。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"D9CB****-****-****-****-********9D23\\\\n\\",\\n \\"Message\\": \\"OK\\\\n\\",\\n \\"Model\\": {\\n \\"CallId\\": \\"550E****-****-****-****-********0CA0\\\\n\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GroupCall' => [ + 'summary' => '向指定号码发送语音验证码和带参数变量的语音通知，支持语音文件模板或文本转语音模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '被叫号码。上限为5万个。', + 'description' => '被叫号码。上限为5万个。', + 'type' => 'array', + 'items' => [ + 'title' => '号码格式：国际码+号码。 例如： 852****0000', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '852****0000', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CallerIdNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '主叫号码。 若您不填该参数，系统将会使用当地随机号码作为外显号码。 若您专属号码外呼，则必须传入已购买的号码，仅支持一个号码。您可以登录国际语音服务控制台，选择"号码管理"查看已购买的号码。', + 'description' => '主叫号码。 若您不填该参数，系统将会使用当地随机号码作为外显号码。 若您专属号码外呼，则必须传入已购买的号码，仅支持一个号码。您可以登录国际语音服务控制台，选择"号码管理"查看已购买的号码。', + 'type' => 'string', + 'required' => false, + 'example' => '852****1111', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'title' => '国家/地区二字码，ISO2。', + 'description' => '国家/地区二字码，ISO2。', + 'type' => 'string', + 'required' => false, + 'example' => 'HK', + ], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => [ + 'title' => '语音文件的播放次数。取值范围：1~3。', + 'description' => '语音文件的播放次数。取值范围：1~3。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SendType', + 'in' => 'query', + 'schema' => [ + 'title' => '发送类型：取值[1,2]。 1： 立即开始发送任务，不等待。 2： 定时开始发送任务。如果传该类型，TimingStart为必选字段。', + 'description' => '发送类型：取值[1,2]。 1： 立即开始发送任务，不等待。 2： 定时开始发送任务。如果传该类型，TimingStart为必选字段。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'title' => '语速控制，取值范围：-500~500。 音频类型为TTS时必传。录音文件可不传。', + 'description' => '语速控制，取值范围：-500~500。 音频类型为TTS时必传。录音文件可不传。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '94', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '任务名称。', + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => '群呼任务', + ], + ], + [ + 'name' => 'TimingStart', + 'in' => 'query', + 'schema' => [ + 'title' => '2022-05-01T08:00:00+08:00', + 'description' => '2022-05-01T08:00:00+08:00', + 'type' => 'string', + 'required' => false, + 'example' => '定时发送的时间。', + ], + ], + [ + 'name' => 'TtsCode', + 'in' => 'query', + 'schema' => [ + 'title' => '文本转语音的模板ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"文本转语音模板"，查看模板ID。 此参数与VoiceCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'description' => '文本转语音的模板ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"文本转语音模板"，查看模板ID。 此参数与VoiceCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'type' => 'string', + 'required' => false, + 'example' => '1****01', + ], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => [ + 'title' => '语音文件的模板ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"语音文件"，查看模板ID。 此参数与TtsCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'description' => '语音文件的模板ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"语音文件"，查看模板ID。 此参数与TtsCode二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。', + 'type' => 'string', + 'required' => false, + 'example' => '2*****01', + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => [ + 'title' => '语音文件播放的音量。取值范围：0~100，默认取值100。', + 'description' => '语音文件播放的音量。取值范围：0~100，默认取值100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'title' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。 字符串类型，长度为1~15个字节。', + 'description' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。 字符串类型，长度为1~15个字节。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => [ + 'title' => '模板中的变量参数，JSON格式。', + 'description' => '模板中的变量参数，JSON格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E50F****-****-****-****-********966F', + ], + 'Message' => [ + 'title' => '返回信息描述', + 'description' => '返回信息描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'Model' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务ID，可以通过此ID查询任务的详情。', + 'description' => '任务ID，可以通过此ID查询任务的详情。', + 'type' => 'string', + 'example' => '550E****-****-****-****-********00A0', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '请求状态码。 返回OK代表请求成功。 其他错误码，请参见API错误码。', + 'description' => '请求状态码。 返回OK代表请求成功。 其他错误码，请参见API错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"E50F****-****-****-****-********966F\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"TaskId\\": \\"550E****-****-****-****-********00A0\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dyvmsapi-intl.ap-southeast-1.aliyuncs.com', + ], + ], +]; |