Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckIfPhoneNumberIsOptedOutCommand

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

example

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

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

CheckIfPhoneNumberIsOptedOutCommandInput for command's input shape.

see

CheckIfPhoneNumberIsOptedOutCommandOutput for command's response shape.

see

config for SNSClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: CheckIfPhoneNumberIsOptedOutCommandInput

Readonly middlewareStack