Sends a voice verification code or a voice notification with parameter variables to a specified phone number. Voice file templates and text-to-speech (TTS) templates are supported.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CallerIdNumber |
string |
No |
The calling number displayed to the recipient. If not specified, a local random number is used. If you use a dedicated outbound call number, specify the purchased number. Only one number can be specified. To view purchased numbers, go to the number management page in the VMS console. |
852****0001 |
| CalledNumber |
string |
No |
The recipient phone number. Prefix the number with the country/region dialing code. Example: 85200****00. |
852****0000 |
| TtsCode |
string |
No |
The TTS template ID. To view template IDs, go to the TTS templates page in the VMS console. You must specify either TtsCode or VoiceCode. TtsCode uses a TTS template for the call content, whereas VoiceCode uses a voice file template. |
1001 |
| TtsParam |
string |
No |
The template variables in JSON format. |
{"code":"1234"} |
| VoiceCode |
string |
No |
The voice file template ID. To view template IDs, go to the voice file templates page in the VMS console. You must specify either TtsCode or VoiceCode. TtsCode uses a TTS template for the call content, whereas VoiceCode uses a voice file template. |
1002 |
| PlayTimes |
integer |
No |
The number of times the voice notification is played during the call. Valid values: 1 to 3. Default value: 3. |
2 |
| Volume |
integer |
No |
The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100. |
100 |
| Speed |
integer |
No |
The playback speed. Valid values: -500 to 500. |
0 |
| TaskName |
string |
No |
The task name. |
单呼任务名 |
| SendType |
integer |
No |
The delivery type. Valid values: 1: delivers the task immediately. 2: delivers the task at a scheduled time. If you set this parameter to 2, you must also specify TimingStart. |
1 |
| TimingStart |
string |
No |
The scheduled delivery time for the task. |
2022-05-01T08:00:00+08:00 |
| OutId |
string |
No |
A custom ID reserved for the caller, returned in the receipt message. The value must be 1 to 15 bytes in length. |
22522**** |
| CountryId |
string |
No |
The ISO2 country/region code. |
HK |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| AccessDeniedDetail |
string |
The access denial details. |
"" |
| Message |
string |
The returned message. |
OK |
| RequestId |
string |
The request ID. |
D9CB****-****-****-****-********9D23 |
| Model |
object |
The returned data. |
|
| Code |
string |
The response code. OK indicates success. For other error codes, see Error codes. |
SUCCESS |
| Success |
boolean |
Indicates whether the request was successful. Valid values: true, false. |
true |
Examples
Success response
JSON format
{
"AccessDeniedDetail": "\"\"",
"Message": "OK",
"RequestId": "D9CB****-****-****-****-********9D23\n",
"Model": {
"test": "test",
"test2": 1
},
"Code": "SUCCESS",
"Success": true
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.