VerifySMSSandboxPhoneNumber -

VerifySMSSandboxPhoneNumber

Verifies a destination phone number with a one-time password (OTP) for the calling AWS account.

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.

OneTimePassword

The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.

Type: String

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

Pattern: ^[0-9]+$

Required: Yes

PhoneNumber

The destination phone number to verify.

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

ResourceNotFound

Can’t perform the action on the specified resource. Make sure that the resource exists.

HTTP Status Code: 404

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

Verification

Indicates that the one-time password (OTP) used for verification is invalid.

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 VerifySMSSandboxPhoneNumber.

Sample Request

https://sns.us-west-2.amazonaws.com/?Action=VerifySMSSandboxPhoneNumber &PhoneNumber=%2B12065550100 &OneTimePassword=7973610 &Version=2010-03-31 &AUTHPARAMS

Sample Response

<VerifySMSSandboxPhoneNumberResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/"> <VerifySMSSandboxPhoneNumberResult> </VerifySMSSandboxPhoneNumberResult> <ResponseMetadata> <RequestId>65e432d1-b1bf-5d5f-a962-6a2b5b4c5c94</RequestId> </ResponseMetadata> </VerifySMSSandboxPhoneNumberResponse>

See Also

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