BatchSendMessageToGlobe - Short Message Service - Alibaba Cloud Documentation Center

Operation description

Usage notes

You cannot call the BatchSendMessageToGlobe operation to send messages to the Chinese mainland.
You can call the BatchSendMessageToGlobe operation to send notifications and promotional messages to a small number of mobile phone numbers at a time. To send messages to a large number of mobile phone numbers at a time, use the mass messaging feature of the SMS console.
To ensure that messages can be sent on time, call the SendMessageToGlobe operation.
In each request, you can send messages to up to 1,000 mobile phone numbers.

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 mobile phone number of the recipient. You must add the dialing code to the beginning of each mobile phone number. For more information, see Dialing codes.	[\"931520581**\",\"931530581\",\"931540581\",\"931550581**\"]
From	string	No	The mobile phone number of the sender. You can specify the sender ID when you call the API operation. The sender ID can contain only digits and letters. If the sender ID contains letters, it can be a maximum of 11 characters in length. If the sender ID contains only digits, it can be a maximum of 15 characters in length.	Alicloud321
Message	string	Yes	The content of the message.	[\"message to 931520581**\",\"message to 931530581\",\"message to 931540581\",\"message to 931550581**\"]
Type	string	No	The type of the message. Valid values: NOTIFY: notification MKT: promotional message	NOTIFY
TaskId	string	No	The ID of the messaging campaign. It must be 1 to 255 characters in length. The ID is the value of the TaskId field in the delivery receipt of the message.	123789****
ValidityPeriod	integer	No	The validity period of the message. Unit: seconds.	600
ChannelId	string	No	The ID of the delivery channel.	sms-djnfjn344

Response elements

Element	Type	Description	Example
	object
ResponseCode	string	The HTTP status code. If OK is returned, the request is successful. For more information, see Error codes.	OK
RequestId	string	The ID of the request.	F655A8D5-B967-440B-8683-DAD6FF8D28D3
FailedList	string	The list of the mobile phone numbers that failed to receive the messages.	["931520581**","931530581**"]
ResponseDescription	string	The description of the status code.	The SMS Send Request was accepted
From	string	The sender ID that was returned. The API operation returns the sender ID that you have specified in the request parameters.	Alicloud321
MessageIdList	string	The ID of the sent message.	["123**","124**"]
SuccessCount	string	The number of sent messages.	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.