Skip to content

PutOptedOutNumber

Source: src/AWS/PinpointSMSVoiceV2/PutOptedOutNumber.ts

Runtime binding for sms-voice:PutOptedOutNumber.

Adds a destination phone number to the bound opt-out list — further messages to it through numbers using this list are suppressed. Use it to honor opt-out requests arriving through channels other than the carrier keywords (support tickets, web forms). The deploy-time half grants sms-voice:PutOptedOutNumber on the list. Provide the implementation with Effect.provide(AWS.PinpointSMSVoiceV2.PutOptedOutNumberHttp).

// init
const optOuts = yield* AWS.PinpointSMSVoiceV2.OptOutList("OptOuts");
const putOptedOut = yield* AWS.PinpointSMSVoiceV2.PutOptedOutNumber(optOuts);
// runtime
yield* putOptedOut({ OptedOutNumber: "+12065550100" });