Call BatchSendMessageToGlobe to send SMS to multiple international recipients - Short Message Service - Alibaba Cloud - Short Message Service

Operation description

This operation does not support sending text messages to the Chinese mainland.
The BatchSendMessageToGlobe operation is mainly used for sending small batches of promotional and notification text messages. To send text messages in large batches, use the quick send feature in the Short Message Service (SMS) console.
If you have requirements for text message timeliness, use the SendMessageToGlobe operation.
In a single request, you can send text messages to up to 1,000 mobile phone numbers.

QPS limit

The queries per second (QPS) limit for a single user (the same Alibaba Cloud account) is 1 call per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make API calls at a reasonable frequency.

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

dysms:BatchSendMessageToGlobe

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
To	string	Yes	The recipient number. The number format is: country code + phone number. For more information about country codes, see Dialing codes.	[\"931520581**\",\"931530581\",\"931540581\",\"931550581**\"]
From	string	No	The sender ID. Sender IDs are supported and can contain only digits and letters. A sender ID that contains letters can be up to 11 characters in length, and a sender ID that contains only digits can be up to 15 characters in length.	Alicloud321
Message	string	Yes	The message content.	[\"message to 931520581**\",\"message to 931530581\",\"message to 931540581\",\"message to 931550581**\"]
Type	string	No	The message type. Valid values: NOTIFY: notification message. MKT: promotional message.	NOTIFY
TaskId	string	No	The task ID. The value can be up to 255 characters in length. You can obtain the task ID from the TaskId field in the text message receipt.	123789****
ValidityPeriod	integer	No	The validity period of the text message. Unit: seconds.	600
ChannelId	string	No	The ID of the text message channel.	sms-djnfjn344

Response elements

Element	Type	Description	Example
	object	The response parameters.
ResponseCode	string	The response code. A value of OK indicates that the request is successful. For other error codes, see Error codes.	OK
RequestId	string	The request ID.	F655A8D5-B967-440B-8683-DAD6FF8D28D3
FailedList	string	The list of numbers to which the text messages failed to be sent.	["931520581**","931530581**"]
ResponseDescription	string	The description of the response code.	The SMS Send Request was accepted
From	string	The sender ID. The value is the sender ID that you specified in the request.	Alicloud321
MessageIdList	string	The IDs of the messages that were successfully sent.	["123**","124**"]
SuccessCount	string	The number of text messages that were successfully sent.	2

Examples

Success response

JSON format

{
  "ResponseCode": "OK",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D28D3",
  "FailedList": "[\"931520581****\",\"931530581****\"]",
  "ResponseDescription": "The SMS Send Request was accepted",
  "From": "Alicloud321",
  "MessageIdList": "[\"123****\",\"124****\"]",
  "SuccessCount": "2"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.