BatchSendMessageToGlobe -

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.

QPS limit

You can call this operation only once per second. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	BatchSendMessageToGlobe	The operation that you want to perform. Set the value to BatchSendMessageToGlobe.
To	String	Yes	[\"931520581**\",\"931530581\",\"931540581\",\"931550581**\"]	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.
From	String	No	Alicloud	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.
Message	String	Yes	[\"message to 931520581**\",\"message to 931530581\",\"message to 931540581\",\"message to 931550581**\"]	The content of the message.
Type	String	Yes	NOTIFY	The type of the message. Valid values: NOTIFY: notification MKT: promotional message
TaskId	String	No	123789****	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.

Response parameters


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

Examples

Sample requests

http(s)://dysmsapi.ap-southeast-1.aliyuncs.com/?Action=BatchSendMessageToGlobe
&To=[\"931520581****\",\"931530581****\",\"931540581****\",\"931550581****\"]
&From=Alicloud
&Message=[\"message to 931520581****\",\"message to 931530581****\",\"message to 931540581****\",\"message to 931550581****\"]
&Type=NOTIFY
&TaskId=123789****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<BatchSendMessageToGlobeResponse>
    <ResponseCode>OK</ResponseCode>
    <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D28D3</RequestId>
    <FailedList>["931520581****","931530581****"]</FailedList>
    <ResponseDescription>The SMS Send Request was accepted</ResponseDescription>
    <From>Alicloud</From>
    <MessageIdList>["123****","124****"]</MessageIdList>
    <SuccessCount>2</SuccessCount>
</BatchSendMessageToGlobeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.