Send Voice Notifications to 50,000 Numbers via VoiceGroupCall - Voice Messaging Service - Alibaba Cloud - Voice Service

Sends multiple voice calls to specified phone numbers by using voice file templates or text-to-speech (TTS) templates.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dyvms:VoiceGroupCall

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CallerIdNumber	string	No	The caller ID number. If you do not specify this parameter, the system uses a random local number as the caller ID. If you use a dedicated number for outbound calls, you must specify a purchased number. Only one number is supported. You can log on to the Voice Messaging Service console and choose Number Management to view purchased numbers.	852****1111
CalledNumber	array	No	The called numbers. The maximum number is 50,000.
	string	No	The number format: country code + phone number. Example: 852****0000.	852****0000
TtsCode	string	No	The ID of the text-to-speech (TTS) template. You can log on to the Voice Messaging Service console and choose Voice Template Management > Text-to-Speech Templates to view the template ID. Either this parameter or VoiceCode is required. These parameters specify whether to use a voice file or fixed template text as the call content.	1****01
TtsParam	string	No	The variable parameters in the template, in JSON format.	{"code":"1234"}
VoiceCode	string	No	The ID of the voice file template. You can log on to the Voice Messaging Service console and choose Voice Template Management > Voice Files to view the template ID. Either this parameter or TtsCode is required. These parameters specify whether to use a voice file or fixed template text as the call content.	2*****01
PlayTimes	integer	No	The number of times the voice file is played. Valid values: 1 to 3.	1
Volume	integer	No	The volume for the voice file playback. Valid values: 0 to 100. Default value: 100.	100
Speed	integer	No	The speech rate. Valid values: -500 to 500. This parameter is required when the audio type is TTS. It is optional for recorded voice files.	100
TaskName	string	No	The name of the task.	Voice broadcast task
SendType	integer	No	The sending type. Valid values: 1: Starts the task immediately. 2: Starts the task at a scheduled time. If you set this parameter to 2, the TimingStart parameter is required.	1
TimingStart	string	No	The scheduled sending time.	2022-05-01T08:00:00+08:00
OutId	string	No	The custom ID that is returned to the caller in the receipt message. The value must be a string and 1 to 15 bytes in length.	22596****
CountryId	string	No	The two-letter country or region code (ISO 3166-1 alpha-2).	HK

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details of the access denial.	""
RequestId	string	The ID of the request.	E50F**----******966F
Message	string	The returned message.	OK
Model	object	The result data of the request.
Code	string	The status code of the request. A value of OK indicates that the request is successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "\"\"",
  "RequestId": "E50F****-****-****-****-********966F",
  "Message": "OK",
  "Model": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.