GET

/search#type=phone-numbers

http://service.chime.aws.amazon.com/search#type=phone-numbers

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

Access Token Required: API Key

Query Params

area-codestring

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

citystring

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

countrystring

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

statestring

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

toll-free-prefixstring

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

phone-number-typestring

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

Allowed:

max-resultsinteger

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

next-tokenstring

The token used to retrieve the next page of results.

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

typestringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://service.chime.aws.amazon.com/search#type=phone-numbers' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}