Sends voice notifications to multiple phone numbers using a voice file or text-to-speech (TTS) template.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CallerIdNumber |
string |
No |
The calling number. If not specified, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, specify the purchased number. Only one number can be specified. You can view purchased phone numbers on the number management page in the VMS console. |
示例值示例值示例值 |
| CalledNumber |
array |
No |
The called numbers. You can specify up to 50,000 numbers. |
|
|
string |
No |
The phone number. The country/region dialing code must be added to the beginning. Example: 852****0000. |
852****0000 |
|
| TtsCode |
string |
No |
The TTS template ID. You can view the template ID on the TTS templates page in the VMS console. 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. |
示例值示例值 |
| TtsParam |
string |
No |
The variables in the template, in JSON format. |
示例值示例值示例值 |
| VoiceCode |
string |
No |
The voice file template ID. You can view the template ID on the voice file templates page in the VMS console. 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. |
示例值示例值 |
| PlayTimes |
integer |
No |
The number of times the voice notification is played during the call. Valid values: 1 to 3. |
38 |
| Volume |
integer |
No |
The playback volume of the voice file. Valid values: 0 to 100. Default value: 100. |
29 |
| Speed |
integer |
No |
The playback speed. Valid values: -500 to 500. Required when a TTS template is used. Not required when a recorded voice file is used. |
58 |
| 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 specify TimingStart. |
54 |
| TimingStart |
string |
No |
The scheduled delivery time for the task. |
示例值 |
| OutId |
string |
No |
The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be 1 to 15 bytes in length. |
示例值 |
| CountryId |
string |
No |
The ISO2 country/region code. |
示例值 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| AccessDeniedDetail |
string |
The details about the access denial. |
"" |
| RequestId |
string |
The request ID. |
示例值示例值 |
| Message |
string |
The returned message. |
示例值 |
| Model |
object |
The returned data. |
|
| Code |
string |
The error code. OK indicates that the request was successful. For other error codes, see Error codes. |
示例值 |
| Success |
boolean |
Indicates whether the request was successful. Valid values: true and false. |
false |
Examples
Success response
JSON format
{
"AccessDeniedDetail": "\"\"",
"RequestId": "示例值示例值",
"Message": "示例值",
"Model": {
"test": "test",
"test2": 1
},
"Code": "示例值",
"Success": false
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.