SendMessageToGlobe - Short Message Service - Alibaba Cloud Documentation Center

Sends messages to regions outside the Chinese mainland, including Hong Kong (China), Macao (China), Taiwan (China).

Operation description

Call this operation to send messages to regions outside the Chinese mainland, including Hong Kong (China), Macao (China), Taiwan (China). You can also send messages in the SMS console.
This operation does not support sending messages to the Chinese mainland.
You cannot use resource plans if your account has an overdue payment. Before you call this operation, check your account balance and the remaining quota in your resource plans.
On the international site (alibabacloud.com), SMS is billed based on the submission status of messages. You are charged even if a carrier receipt indicates that the message failed to be delivered. For more information about resource plans and the pay-as-you-go billing method, see Billing.

QPS limits

You can call this operation up to 2,000 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions.

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:SendMessageToGlobe

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
To	string	Yes	The phone numbers to which the message is sent. Format: `Dialing code + Phone number`. For example, 8521245567**. For dialing odes, see Dialing codes. Note** You cannot call this operation to send messages to the Chinese mainland.	8521245567****
From	string	No	The phone number of the sender. You can also specify a sender ID, which can contain letters and digits. An alphanumeric ID can be up to 11 characters, while a numeric-only ID can have up to 15 digits.	Alicloud321
Message	string	Yes	The message content.	Hello
Type	string	No	The message type. Valid values: OTP: verification code message. NOTIFY: notification. MKT: marketing message.	NOTIFY
TaskId	string	No	The ID of the task. The ID can be up to 255 characters in length. You can obtain the task ID from the TaskId field in the message receipt.	123****789
ValidityPeriod	integer	No	The validity period of the message, in seconds.	600
ChannelId	string	No	The ID of the channel.	3790

Response elements

Element	Type	Description	Example
	object	The response parameters.
ResponseCode	string	The status code of the delivery request.	OK
NumberDetail	object	The phone number details.
Carrier	string	The carrier.	CMI
Region	string	The region to which the phone number belongs.	HongKong
Country	string	The country where the number is registered.	China
RequestId	string	The request ID.	F655A8D5-B967-440B-8683-DAD6FF8DE990
Segments	string	The number of billed messages.	1
ResponseDescription	string	The description of the delivery request status.	The SMS Send Request was accepted
From	string	The sender ID that you specified.	Alicloud321
To	string	The phone number to which the message is sent.	1380000****
MessageId	string	The message ID.	1008030300****

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.