Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Sends a templated text message through a notify configuration to a recipient's phone number.

post/#X-Amz-Target=PinpointSMSVoiceV2.SendNotifyTextMessage

Headers

X-Amz-Target'PinpointSMSVoiceV2.SendNotifyTextMessage' required

Request body

NotifyConfigurationIdstring required

The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.

DestinationPhoneNumberstring required

The destination phone number in E.164 format.

TemplateIdstring

The unique identifier of the template to use for the message.

TemplateVariablesobject required

A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass <code>INTEGER</code> values as <code>"42"</code> and <code>BOOLEAN</code> values as <code>"true"</code> or <code>"false"</code>.

TimeToLiveinteger

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

Contextobject

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

ConfigurationSetNamestring

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

DryRunboolean

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

MessageFeedbackEnabledboolean

Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <a>PutMessageFeedback</a>.

Response

Success

MessageIdstring

The unique identifier for the message.

TemplateIdstring

The unique identifier of the template used for the message.

ResolvedMessageBodystring

The message body after template variable substitution has been applied.