CreateSMSSandboxPhoneNumber -

CreateSMSSandboxPhoneNumber

Adds a destination phone number to an AWS account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your AWS account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

Request Parameters

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

LanguageCode

The language to use for sending the OTP. The default value is en-US.

Type: String

Valid Values: en-US | en-GB | es-419 | es-ES | de-DE | fr-CA | fr-FR | it-IT | ja-JP | pt-BR | kr-KR | zh-CN | zh-TW

Required: No

PhoneNumber

The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

Type: String

Length Constraints: Maximum length of 20.

Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$

Required: Yes

Errors

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

AuthorizationError

Indicates that the user has been denied access to the requested resource.

HTTP Status Code: 403

InternalError

Indicates an internal service error.

HTTP Status Code: 500

InvalidParameter

Indicates that a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

OptedOut

Indicates that the specified phone number opted out of receiving SMS messages from your AWS account. You can't send SMS messages to phone numbers that opt out.

HTTP Status Code: 400

Throttled

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your AWS account.

HTTP Status Code: 429

UserError

Indicates that a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

Examples

The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of the complete Signature Version 4 signing process (Python) in the AWS General Reference.

Example

This example illustrates one usage of CreateSMSSandboxPhoneNumber.

Sample Request

https://sns.us-west-2.amazonaws.com/?Action=CreateSMSSandboxPhoneNumber &PhoneNumber=%2B12065550100 &LanguageCode=en-US &Version=2010-03-31 &AUTHPARAMS

Sample Response

<CreateSMSSandboxPhoneNumberResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/"> <CreateSMSSandboxPhoneNumberResult> </CreateSMSSandboxPhoneNumberResult> <ResponseMetadata> <RequestId>0d30fe4d-b737-5759-a82a-a6b75f920cdb</RequestId> </ResponseMetadata> </CreateSMSSandboxPhoneNumberResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: