CreateCallTask-阿里云帮助中心

Uses a service instance to create a text-to-speech (TTS) task, a voice notification task, or a voice verification code task for multiple called numbers.

Operation description

You can create up to 1,000 voice notifications for each task.

QPS limits

You can call this operation up to 100 times per second per account.

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:CreateCallTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskName	string	No	The task name.	语音通知
BizType	string	No	The type of the task template. Valid values: VMS_VOICE_TTS: the text-to-speech (TTS) notification template. VMS_VOICE_CODE: the voice notification template. VMS_TTS: the voice verification code template.	VMS_VOICE_CODE
TemplateCode	string	No	The template ID.	TTS_2122****
TemplateName	string	No	The template name.	语音通知模板
ResourceType	string	No	The type of the calling number. Set the value to LIST.	LIST
Resource	string	No	The calling number. Only virtual numbers are supported.	05516214****
DataType	string	No	The type of called numbers. Valid values: LIST: the called numbers that are separated by commas (,). JSON: a JSON-formatted list of called numbers with template parameters.	JSON
Data	string	No	The called numbers. If you set DataType to LIST, the value of Data is in the LIST format. If you set DataType to JSON, the value of Data is in the JSON format.	{ "paramNames":["name",,"key"], "calleeList":[ { "callee":"1310000**", "params":["张三","淘宝订单"] }, { "callee":"1320000**", "params":["李四","天猫订单"] } ] }
FireTime	string	No	This parameter is unavailable.	1
StopTime	string	No	This parameter is unavailable.	1
ScheduleType	string	No	This parameter is unavailable.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
Code	string	The response code.	OK
Data	integer	The task ID.	18390**
RequestId	string	The request ID.	ED815433-724A-4357-9991-A54AD2FF09FD

Examples

Success response

JSON format

{
  "Code": "OK",
  "Data": 0,
  "RequestId": "ED815433-724A-4357-9991-A54AD2FF09FD"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters	The parameter is invalid.	The specified parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.