All Products
Search

This Product

    Short Message Service:BatchSendMessageToGlobe

    Document Center

    Short Message Service:BatchSendMessageToGlobe

    Last Updated:Apr 19, 2024

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

    Operation description

    • 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 limited 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.
    • For time-sensitive related messages, we recommend that you use the SendMessageToGlobe operation to ensure that messages are delivered on time.
    • In each request, you can send messages to up to 1,000 mobile phone numbers.

    QPS limits

    You can call this operation only once per second. If the number of calls per second exceeds this limit, throttling will be triggered. This can potentially impact your business operations. Therefore, we recommend that you take note of this limit when making calls to this operation.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:
      • The required resource types are displayed in bold characters.
      • 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
    dysms:BatchSendMessageToGlobeWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TostringYes

    The mobile phone numbers to which the message is sent. 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 also specify a sender ID. The sender ID can contain both letters and digits. If it does, the ID must be between 1 to 11 characters in length. If the sender ID contains only digits, it must be 1 to 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.

    		1

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    ResponseCodestring

    The 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 mobile phone numbers that failed to receive the message.

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

    The description of the status code.

    		The SMS Send Request was accepted
    Fromstring

    The sender ID returned.

    		Alicloud321
    MessageIdListstring

    The ID of the message.

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

    The number of mobile phone numbers that received the message.

    		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
    2023-06-27The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ValidityPeriod