Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use <a>VerifyDestinationNumber</a> to opt-in the verified destination phone number to receive messages.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.SendDestinationNumberVerificationCode' required

Request body

VerifiedDestinationNumberIdstring required

The unique identifier for the verified destination phone number.

VerificationChannel'TEXT' | 'VOICE' required

Choose to send the verification code as an SMS or voice message.

LanguageCode'DE_DE' | 'EN_GB' | 'EN_US' | 'ES_419' | 'ES_ES' | 'FR_CA' | 'FR_FR' | 'IT_IT' | 'JA_JP' | 'KO_KR' | 'PT_BR' | 'ZH_CN' | 'ZH_TW'

Choose the language to use for the message.

OriginationIdentitystring
<p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
ConfigurationSetNamestring

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

Contextobject

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

DestinationCountryParametersobject

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 <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html">Special requirements for sending SMS messages to recipients in India</a>.

Response

Success

MessageIdstring required

The unique identifier for the message.