Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

SendTextMessage

Creates a new text message and sends it to a recipient's phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.

Request Syntax


{
   "ConfigurationSetName": "string",
   "Context": { 
      "string" : "string" 
   },
   "DestinationCountryParameters": { 
      "string" : "string" 
   },
   "DestinationPhoneNumber": "string",
   "DryRun": boolean,
   "Keyword": "string",
   "MaxPrice": "string",
   "MessageBody": "string",
   "MessageType": "string",
   "OriginationIdentity": "string",
   "TimeToLive": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConfigurationSetName

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: No

Context

You can specify custom data in this field. If you do, that data is logged to the event destination.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 5 items.

Key Length Constraints: Minimum length of 1. Maximum length of 100.

Key Pattern: \S+

Value Length Constraints: Minimum length of 1. Maximum length of 800.

Value Pattern: (?!\s)^[\s\S]+(?<!\s)

Required: No

DestinationCountryParameters

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 10 items.

Valid Keys: IN_TEMPLATE_ID | IN_ENTITY_ID

Value Length Constraints: Minimum length of 1. Maximum length of 64.

Value Pattern: \S+

Required: No

DestinationPhoneNumber

The destination phone number in E.164 format.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: \+?[1-9][0-9]{1,18}

Required: Yes

DryRun

When set to true, the message is checked and validated, but isn't sent to the end recipient.

Type: Boolean

Required: No

Keyword

When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 30.

Pattern: [ \S]+

Required: No

MaxPrice

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 8.

Pattern: [0-9]{0,2}\.[0-9]{1,5}

Required: No

MessageBody

The body of the text message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: (?!\s*$)[\s\S]+

Required: No

MessageType

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

Required: No

OriginationIdentity

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/\+-]+

Required: No

TimeToLive

How long the text message is valid for. By default this is 72 hours.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 259200.

Required: No

Response Syntax


{
   "MessageId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MessageId

The unique identifier for the message.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400