DescribeOptedOutNumbers - Amazon Pinpoint SMS and Voice v2 API

DescribeOptedOutNumbers

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.

Request Syntax

{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "OptedOutNumbers": [ "string" ], "OptOutListName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

An array of OptedOutFilter objects to filter the results on.

Type: Array of OptedOutFilter objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

MaxResults

The maximum number of results to return per each request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: No

OptedOutNumbers

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: \+?[1-9][0-9]{1,18}

Required: No

OptOutListName

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax

{ "NextToken": "string", "OptedOutNumbers": [ { "EndUserOptedOut": boolean, "OptedOutNumber": "string", "OptedOutTimestamp": number } ], "OptOutListArn": "string", "OptOutListName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

OptedOutNumbers

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

Type: Array of OptedOutNumberInformation objects

OptOutListArn

The Amazon Resource Name (ARN) of the OptOutList.

Type: String

OptOutListName

The name of the OptOutList.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: