All Products
Search
Document Center

Short Message Service:SendMessageToGlobe

Last Updated:May 27, 2024

Sends a message to regions outside the Chinese mainland.

Operation description

Usage notes

The SendMessageToGlobe API operation does not support message delivery to the Chinese mainland.

QPS limit

You can call this operation up to 30 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call 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:SendMessageToGlobeWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TostringYes

The mobile phone number to which the message is sent. You must add the dialing code to the beginning of the mobile phone number. Example: 8521245567****.

For more information, see Dialing codes.

Note You cannot call the SendMessageToGlobe operation to send messages to the Chinese mainland.
8521245567****
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.

Hello
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.

123****789
ValidityPeriodlongNo

The validity period of the message. Unit: seconds.

600
ChannelIdstringNo

The ID of the channel.

3790

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ResponseCodestring

The status code of the delivery request.

OK
NumberDetailobject

The details about the mobile phone number of the recipient.

Carrierstring

The carrier that owns the mobile phone number.

CMI
Regionstring

The region to which the mobile phone number belongs.

HongKong
Countrystring

The country to which the mobile phone number belongs.

China
RequestIdstring

The ID of the request.

F655A8D5-B967-440B-8683-DAD6FF8DE990
Segmentsstring

The number of messages that incurred fees.

1
ResponseDescriptionstring

The description of the delivery request status.

The SMS Send Request was accepted
Fromstring

The sender ID returned.

Alicloud321
Tostring

The mobile phone number to which the message was sent.

1380000****
MessageIdstring

The ID of the message.

1008030300****

Examples

Sample success responses

JSONformat

{
  "ResponseCode": "OK",
  "NumberDetail": {
    "Carrier": "CMI",
    "Region": "HongKong",
    "Country": "China"
  },
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
  "Segments": "1",
  "ResponseDescription": "The SMS Send Request was accepted",
  "From": "Alicloud321",
  "To": "1380000****",
  "MessageId": "1008030300****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-03-28The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ChannelId
2023-06-27API Description Update. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ValidityPeriod