Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribePhoneNumbers

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an error is returned.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "Owner": "string",
   "PhoneNumberIds": [ "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 PhoneNumberFilter objects to filter the results.

Type: Array of PhoneNumberFilter 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

Owner

Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.

Type: String

Valid Values: SELF | SHARED

Required: No

PhoneNumberIds

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Important

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

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 256.

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

Required: No

Response Syntax


{
   "NextToken": "string",
   "PhoneNumbers": [ 
      { 
         "CreatedTimestamp": number,
         "DeletionProtectionEnabled": boolean,
         "IsoCountryCode": "string",
         "MessageType": "string",
         "MonthlyLeasingPrice": "string",
         "NumberCapabilities": [ "string" ],
         "NumberType": "string",
         "OptOutListName": "string",
         "PhoneNumber": "string",
         "PhoneNumberArn": "string",
         "PhoneNumberId": "string",
         "PoolId": "string",
         "RegistrationId": "string",
         "SelfManagedOptOutsEnabled": boolean,
         "Status": "string",
         "TwoWayChannelArn": "string",
         "TwoWayChannelRole": "string",
         "TwoWayEnabled": boolean
      }
   ]
}

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

PhoneNumbers

An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.

Type: Array of PhoneNumberInformation objects

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