Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListPhoneNumbersOptedOutCommand

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

example

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

import { SNSClient, ListPhoneNumbersOptedOutCommand } from "@aws-sdk/client-sns"; // ES Modules import
// const { SNSClient, ListPhoneNumbersOptedOutCommand } = require("@aws-sdk/client-sns"); // CommonJS import
const client = new SNSClient(config);
const command = new ListPhoneNumbersOptedOutCommand(input);
const response = await client.send(command);
see

ListPhoneNumbersOptedOutCommandInput for command's input shape.

see

ListPhoneNumbersOptedOutCommandOutput for command's response shape.

see

config for SNSClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: ListPhoneNumbersOptedOutCommandInput

Readonly middlewareStack

Methods

Static getEndpointParameterInstructions