paws.application.integration (version 0.1.11)

sns_check_if_phone_number_is_opted_out: Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account

Description

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your 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 opt_in_phone_number action.

Usage

sns_check_if_phone_number_is_opted_out(phoneNumber)

Arguments

phoneNumber

[required] The phone number for which you want to check the opt out status.

Value

A list with the following syntax:

list(
  isOptedOut = TRUE|FALSE
)

Request syntax

svc$check_if_phone_number_is_opted_out(
  phoneNumber = "string"
)