Describe Opted Out Numbers

pinpointsmsvoicev2_describe_opted_out_numbers

R Documentation

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list¶

Description¶

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an error is returned.

Usage¶

pinpointsmsvoicev2_describe_opted_out_numbers(OptOutListName,
  OptedOutNumbers, Filters, NextToken, MaxResults)

Arguments¶

OptOutListName: [required] The OptOutListName or OptOutListArn of the OptOutList. You can use describe_opt_out_lists to find the values for OptOutListName and OptOutListArn.
OptedOutNumbers: An array of phone numbers to search for in the OptOutList.
Filters: An array of OptedOutFilter objects to filter the results on.
NextToken: The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
MaxResults: The maximum number of results to return per each request.

Value¶

A list with the following syntax:

list(
  OptOutListArn = "string",
  OptOutListName = "string",
  OptedOutNumbers = list(
    list(
      OptedOutNumber = "string",
      OptedOutTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      EndUserOptedOut = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_opted_out_numbers(
  OptOutListName = "string",
  OptedOutNumbers = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "end-user-opted-out",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)