SearchAvailablePhoneNumbers - Amazon Chime

The Amazon Chime SDK identity, meetings, and messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.

SearchAvailablePhoneNumbers

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

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

The area code used to filter results. Only applies to the US.

City

The city used to filter results. Only applies to the US.

Country

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

Pattern: [A-Z]{2}

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 used to retrieve the next page of results.

PhoneNumberType

The phone number type used to filter results. Required for non-US numbers.

Valid Values: Local | TollFree

State

The state used to filter results. Required only if you provide City. Only applies to the US.

TollFreePrefix

The toll-free prefix that you use to filter results. Only applies to the US.

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

List of phone numbers, in E.164 format.

Type: Array of strings

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

NextToken

The token used to retrieve the next page of search results.

Type: String

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation.

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

Examples

In the following examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example searches for phone numbers with an area code of 206.

Sample Request

GET /search?type=phone-numbers&area-code=206 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T180157Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 98bb7b5b-0f5b-48c3-a959-ab0d7fd42b97 Content-Type: application/json Content-Length: 1522 Date: Wed, 18 Sep 2019 18:01:57 GMT Connection: keep-alive {"E164PhoneNumbers":["+12065550100","+12065550101","+12065550102"], "NextToken": null}

Example

This example searches local phone numbers in the United Kingdom.

Sample Request

GET /search?type=phone-numbers&country=GB&phone-number-type=Local HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20210224T201356Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 86b1ec89-b95b-47de-bd67-92c6d778bbd5 Content-Type: application/json Content-Length: 1522 Date: Wed, 24 Feb 2021 20:13:56 GMT Connection: keep-alive {"E164PhoneNumbers":["+442012345677","+442012345678","+442012345679"], "NextToken": null}

See Also

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