DescribeOptedOutNumbers

Source: src/AWS/PinpointSMSVoiceV2/DescribeOptedOutNumbers.ts

Runtime binding for sms-voice:DescribeOptedOutNumbers.

Lists the opted-out destination numbers in the bound opt-out list (one page per call — pass NextToken from the previous response to continue). Use it to check whether a number opted out before sending. The deploy-time half grants sms-voice:DescribeOptedOutNumbers on the list. Provide the implementation with Effect.provide(AWS.PinpointSMSVoiceV2.DescribeOptedOutNumbersHttp).

Managing Opt-Outs

// init
const describeOptedOut =
  yield* AWS.PinpointSMSVoiceV2.DescribeOptedOutNumbers(optOuts);

// runtime
const { OptedOutNumbers } = yield* describeOptedOut({
  OptedOutNumbers: ["+12065550100"],
});
const optedOut = (OptedOutNumbers ?? []).length > 0;