Send OTP Voice Codes via VoiceSingleCall API - Voice Messaging Service - Alibaba Cloud - Voice Service

Sends voice verification codes and voice notifications with parameter variables to specified numbers, and supports voice file templates or text-to-speech 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:VoiceSingleCall

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 the purchased numbers.	852****0001
CalledNumber	string	No	The mobile phone number that receives the voice notification. Number format: country code + phone number. Example: 85200****00.	852****0000
TtsCode	string	No	The ID of the text-to-speech 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. You must specify either this parameter or VoiceCode. This parameter specifies that fixed template text is used as the call content, whereas VoiceCode specifies that a voice file is used.	1001
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. You must specify either this parameter or TtsCode. This parameter specifies that a voice file is used as the call content, whereas TtsCode specifies that fixed template text is used.	1002
PlayTimes	integer	No	The number of times the voice notification content is played during a single 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 speech rate. Valid values: -500 to 500.	0
TaskName	string	No	The name of the task.	Single call task name
SendType	integer	No	The sending type. Valid values: 1: Starts the sending task immediately without waiting. 2: Starts the sending task at a scheduled time. If you specify this value, TimingStart is required.	1
TimingStart	string	No	The scheduled time for sending the message.	2022-05-01T08:00:00+08:00
OutId	string	No	The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value must be a string that is 1 to 15 bytes in length.	22522****
CountryId	string	No	The ISO2 country or region code.	HK

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details of the access denial.	""
Message	string	The returned message.	OK
RequestId	string	The request ID.	D9CB**----******9D23
Model	object	The request result data.
Code	string	The request status code. A value of SUCCESS indicates that the request is successful. For other error codes, see API error codes.	SUCCESS
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": "\"\"",
  "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.