Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchAvailablePhoneNumbers

Searches the provisioned phone numbers in an organization.

Request Syntax


GET /search?type=phone-numbers&area-code=AreaCode&city=City&country=Country&max-results=MaxResults&next-token=NextToken&phone-number-type=PhoneNumberType&state=State&toll-free-prefix=TollFreePrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AreaCode

Confines a search to just the phone numbers associated with the specified area code.

City

Confines a search to just the phone numbers associated with the specified city.

Country

Confines a search to just the phone numbers associated with the specified country.

Pattern: [A-Z]{2}

MaxResults

The maximum number of results to return.

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

NextToken

The token used to return the next page of results.

PhoneNumberType

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

Valid Values: Local | TollFree

State

Confines a search to just the phone numbers associated with the specified state.

TollFreePrefix

Confines a search to just the phone numbers associated with the specified toll-free prefix.

Length Constraints: Fixed length of 3.

Pattern: ^8(00|33|44|55|66|77|88)$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ],
   "NextToken": "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.

E164PhoneNumbers

Confines a search to just the phone numbers in the E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

NextToken

The token used to return the next page of results.

Type: String

Errors

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

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401