Own AWS? Customize your docs with AI search, analytics, and more.

GET

/phone-numbers

http://service.chime.aws.amazon.com/phone-numbers

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Access Token Required: API Key

Query Params

statusstring

The phone number status.

Allowed:

product-typestring

The phone number product type.

Allowed:

filter-namestring

The filter to use to limit the number of results.

Allowed:

filter-valuestring

The value to use for the filter.

max-resultsinteger

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

next-tokenstring

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

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

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

GET

/phone-numbers

http://service.chime.aws.amazon.com/phone-numbers

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Access Token Required: API Key

Query Params

statusstring

The phone number status.

Allowed:

product-typestring

The phone number product type.

Allowed:

filter-namestring

The filter to use to limit the number of results.

Allowed:

filter-valuestring

The value to use for the filter.

max-resultsinteger

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

next-tokenstring

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

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

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

GET

/phone-numbers

http://service.chime.aws.amazon.com/phone-numbers

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Access Token Required: API Key

Query Params

statusstring

The phone number status.

Allowed:

product-typestring

The phone number product type.

Allowed:

filter-namestring

The filter to use to limit the number of results.

Allowed:

filter-valuestring

The value to use for the filter.

max-resultsinteger

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

next-tokenstring

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

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

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

GET

/phone-numbers

http://service.chime.aws.amazon.com/phone-numbers

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Access Token Required: API Key

Query Params

statusstring

The phone number status.

Allowed:

product-typestring

The phone number product type.

Allowed:

filter-namestring

The filter to use to limit the number of results.

Allowed:

filter-valuestring

The value to use for the filter.

max-resultsinteger

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

next-tokenstring

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

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

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