SNS / Client / list_sms_sandbox_phone_numbers

list_sms_sandbox_phone_numbers#

SNS.Client.list_sms_sandbox_phone_numbers(**kwargs)#

Lists the calling Amazon Web Services account’s current verified and pending destination phone numbers in the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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.

See also: AWS API Documentation

Request Syntax

response = client.list_sms_sandbox_phone_numbers(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – Token that the previous ListSMSSandboxPhoneNumbersInput request returns.

  • MaxResults (integer) – The maximum number of phone numbers to return.

Return type:

dict

Returns:

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumber': 'string',
            'Status': 'Pending'|'Verified'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PhoneNumbers (list) –

      A list of the calling account’s pending and verified phone numbers.

      • (dict) –

        A verified or pending destination phone number in the SMS sandbox.

        When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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.

        • PhoneNumber (string) –

          The destination phone number.

        • Status (string) –

          The destination phone number’s verification status.

    • NextToken (string) –

      A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.

Exceptions

  • SNS.Client.exceptions.AuthorizationErrorException

  • SNS.Client.exceptions.InternalErrorException

  • SNS.Client.exceptions.InvalidParameterException

  • SNS.Client.exceptions.ResourceNotFoundException

  • SNS.Client.exceptions.ThrottledException