Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

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 exception is returned.

post/#X-Amz-Target=PinpointSMSVoiceV2.DescribeOptedOutNumbers

Headers

X-Amz-Target'PinpointSMSVoiceV2.DescribeOptedOutNumbers' required

Request body

OptOutListNamestring required
<p>The OptOutListName or OptOutListArn of the OptOutList. You can use <a>DescribeOptOutLists</a> to find the values for OptOutListName and OptOutListArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
OptedOutNumbersPhoneNumber[]
<p>An array of phone numbers to search for in the OptOutList.</p> <p>If you specify an opted out number that isn't valid, an exception is returned.</p>
NextTokenstring

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.

MaxResultsinteger

The maximum number of results to return per each request.

Response

Success

OptOutListArnstring

The Amazon Resource Name (ARN) of the OptOutList.

OptOutListNamestring

The name of the OptOutList.

NextTokenstring

The token to be used for the next set of paginated results. If this field is empty then there are no more results.