BatchSendMessageToGlobe

Updated at: 2025-03-21 08:01

Sends a message to multiple recipients in countries or regions outside the Chinese mainland.

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
dysms:BatchSendMessageToGlobecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
TostringYes

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****\"]
FromstringNo

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
MessagestringYes

The content of the message.

[\"message to 931520581****\",\"message to 931530581****\",\"message to 931540581****\",\"message to 931550581****\"]
TypestringYes

The type of the message. Valid values:

  • NOTIFY: notification
  • MKT: promotional message
NOTIFY
TaskIdstringNo

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****
ValidityPeriodlongNo

The validity period of the message. Unit: seconds.

600
ChannelIdstringNo

The ID of the delivery channel.

sms-djnfjn344

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
ResponseCodestring

The HTTP status code. If OK is returned, the request is successful. For more information, see Error codes.

OK
RequestIdstring

The ID of the request.

F655A8D5-B967-440B-8683-DAD6FF8D28D3
FailedListstring

The list of the mobile phone numbers that failed to receive the messages.

["931520581****","931530581****"]
ResponseDescriptionstring

The description of the status code.

The SMS Send Request was accepted
Fromstring

The sender ID that was returned. The API operation returns the sender ID that you have specified in the request parameters.

Alicloud321
MessageIdListstring

The ID of the sent message.

["123****","124****"]
SuccessCountstring

The number of sent messages.

2

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2024-10-18The request parameters of the API has changedView Change Details
2023-06-27The request parameters of the API has changedView Change Details
  • On this page (1)
  • Operation description
  • Usage notes
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare