List Phone Numbers Opted Out

sns_list_phone_numbers_opted_out

R Documentation

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them¶

Description¶

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for list_phone_numbers_opted_out are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call list_phone_numbers_opted_out again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

Usage¶

sns_list_phone_numbers_opted_out(nextToken)

Arguments¶

nextToken: A NextToken string is used when you call the list_phone_numbers_opted_out action to retrieve additional records that are available after the first page of results.

Value¶

A list with the following syntax:

list(
  phoneNumbers = list(
    "string"
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_phone_numbers_opted_out(
  nextToken = "string"
)