ListPhoneNumbersOptedOut
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut 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 ListPhoneNumbersOptedOut again using the
NextToken string received from the previous call. When there are no
more records to return, NextToken will be null.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- nextToken
-
A
NextTokenstring is used when you call theListPhoneNumbersOptedOutaction to retrieve additional records that are available after the first page of results.Type: String
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
A
NextTokenstring is returned when you call theListPhoneNumbersOptedOutaction if additional records are available after the first page of results.Type: String
- phoneNumbers.member.N
-
A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.
Type: Array of strings
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationError
-
Indicates that the user has been denied access to the requested resource.
HTTP Status Code: 403
- InternalError
-
Indicates an internal service error.
HTTP Status Code: 500
- InvalidParameter
-
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- Throttled
-
Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
- message
-
Throttled request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: