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.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CalledNumber | array | No | The called numbers. You can specify up to 50,000 phone numbers. | |
| string | No | You must add the country code to the beginning of the phone numbers. Example: 852****0000. | 852****0000 | |
| CallerIdNumber | string | No | 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 choose Number Management to view the purchased phone numbers. | 852****1111 |
| CountryId | string | No | The ISO2 country code. | HK |
| PlayTimes | long | No | The number of times the audio file is played. Valid values: 1 to 3. | 1 |
| SendType | long | No | The delivery type. Valid values: 1 and 2. 1: The audio file is delivered immediately. 2: The audio file is delivered at a scheduled time. If you specify SendType as 2, you must specify TimingStart. | 2 |
| Speed | long | No | The playback speed. Valid values: -500 to 500. 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. | 0 |
| TaskName | string | No | The task name. | |
| TimingStart | string | No | The time when the audio file is scheduled to be delivered. | 2022-05-01T08:00:00+08:00 |
| TtsCode | string | No | The voice template ID of the audio file. You can log on to the VMS console and choose Voice Call Template > Audio File to view the template ID. 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. | 100001 |
| VoiceCode | string | No | The TTS template ID. You can log on to the VMS console and choose Voice Call Template > TTS Template to view the template ID. 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. | 200001 |
| Volume | long | No | The playback volume of the audio file. Valid values: 0 to 100. Default value: 100. | 100 |
| OutId | string | No | The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be of the STRING type and 1 to 15 bytes in length. | 22596**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "E50FFA85-0B79-4421-A7BD-00B0A271966F",
"Code": "OK",
"Message": "OK",
"TaskId": "550e8400-e29b-41d4-a716-446655440000"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. |
| 400 | System.LimitControl | The system is under flow control. |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-10-12 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2023-03-14 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
|