paws.customer.engagement (version 0.8.0)

pinpointsmsvoicev2_describe_opted_out_numbers: 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.

See https://www.paws-r-sdk.com/docs/pinpointsmsvoicev2_describe_opted_out_numbers/ for full documentation.

Usage

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

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.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

OptedOutNumbers

An array of phone numbers to search for in the OptOutList.

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

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.