Amazon Chime
API Reference (API Version 2018-05-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

SearchAvailablePhoneNumbers

Searches phone numbers that can be ordered.

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.

AreaCode

The area code used to filter results.

City

The city used to filter results.

Country

The country used to filter results.

MaxResults

The maximum number of results to return in a single call.

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

NextToken

The token to use to retrieve the next page of results.

State

The state used to filter results.

TollFreePrefix

The toll-free prefix that you use to filter results.

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" ] }

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

List of phone numbers, in E.164 format.

Type: Array of strings

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

Errors

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

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. For example, when a user tries to create an account from an unsupported Region.

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 client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

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