OptOutList

Source: src/AWS/PinpointSMSVoiceV2/OptOutList.ts

An AWS End User Messaging SMS (Pinpoint SMS Voice v2) opt-out list — a list of destination phone numbers that opted out of receiving your SMS or voice messages.

When an end user replies with a supported opt-out keyword (STOP, CANCEL, OPTOUT, …), their number is added to the list automatically and further messages to it are suppressed.

Creating Opt-Out Lists

Basic Opt-Out List

import * as PinpointSMSVoiceV2 from "alchemy/AWS/PinpointSMSVoiceV2";

const optOuts = yield* PinpointSMSVoiceV2.OptOutList("OptOuts");

Named Opt-Out List with Tags

const optOuts = yield* PinpointSMSVoiceV2.OptOutList("OptOuts", {
  optOutListName: "marketing-opt-outs",
  tags: { team: "growth" },
});