Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class ListSMSSandboxPhoneNumbersCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { SNSClient, ListSMSSandboxPhoneNumbersCommand } from "@aws-sdk/client-sns"; // ES Modules import
// const { SNSClient, ListSMSSandboxPhoneNumbersCommand } = require("@aws-sdk/client-sns"); // CommonJS import
const client = new SNSClient(config);
const input = { // ListSMSSandboxPhoneNumbersInput
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListSMSSandboxPhoneNumbersCommand(input);
const response = await client.send(command);
// { // ListSMSSandboxPhoneNumbersResult
// PhoneNumbers: [ // SMSSandboxPhoneNumberList // required
// { // SMSSandboxPhoneNumber
// PhoneNumber: "STRING_VALUE",
// Status: "Pending" || "Verified",
// },
// ],
// NextToken: "STRING_VALUE",
// };

Param

ListSMSSandboxPhoneNumbersCommandInput

Returns

ListSMSSandboxPhoneNumbersCommandOutput

See

Throws

AuthorizationErrorException (client fault)

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

Throws

InternalErrorException (server fault)

Indicates an internal service error.

Throws

InvalidParameterException (client fault)

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

Throws

ResourceNotFoundException (client fault)

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

Throws

ThrottledException (client fault)

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

Throws

SNSServiceException

Base exception class for all service exceptions from SNS service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods