---
title: "GET /phone-numbers"
method: GET
path: "/phone-numbers"
---

# GET /phone-numbers

`GET /phone-numbers`

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

## Query parameters

- `status` string
- `product-type` 'VoiceConnector' | 'SipMediaApplicationDialIn'
- `filter-name` 'VoiceConnectorId' | 'VoiceConnectorGroupId' | 'SipRuleId'
- `filter-value` string
- `max-results` integer
- `next-token` string

## Response `200`

Success

- ListPhoneNumbersResponse
  - `PhoneNumbers` PhoneNumber[] — The phone number details.
    - `PhoneNumberId` string, password — The phone number's ID.
    - `E164PhoneNumber` string, password — The phone number, in E.164 format.
    - `Country` string — The phone number's country. Format: ISO 3166-1 alpha-2.
    - `Type` 'Local' | 'TollFree' — The phone number's type.
    - `ProductType` 'VoiceConnector' | 'SipMediaApplicationDialIn' — The phone number's product type.
    - `Status` 'Cancelled' | 'PortinCancelRequested' | 'PortinInProgress' | 'AcquireInProgress' | 'AcquireFailed' | 'Unassigned' | 'Assigned' | 'ReleaseInProgress' | 'DeleteInProgress' | 'ReleaseFailed' | 'DeleteFailed' — The phone number's status.
    - `Capabilities` object — The phone number's capabilities.
      - `InboundCall` boolean — Allows or denies inbound calling for the specified phone number.
      - `OutboundCall` boolean — Allows or denies outbound calling for the specified phone number.
      - `InboundSMS` boolean — Allows or denies inbound SMS messaging for the specified phone number.
      - `OutboundSMS` boolean — Allows or denies outbound SMS messaging for the specified phone number.
      - `InboundMMS` boolean — Allows or denies inbound MMS messaging for the specified phone number.
      - `OutboundMMS` boolean — Allows or denies inbound MMS messaging for the specified phone number.
    - `Associations` PhoneNumberAssociation[] — The phone number's associations.
      - `Value` string — Contains the ID for the entity specified in Name.
      - `Name` 'VoiceConnectorId' | 'VoiceConnectorGroupId' | 'SipRuleId' — Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
      - `AssociatedTimestamp` string, date-time — The timestamp of the phone number association, in ISO 8601 format.
    - `CallingName` string, password — The outbound calling name associated with the phone number.
    - `CallingNameStatus` 'Unassigned' | 'UpdateInProgress' | 'UpdateSucceeded' | 'UpdateFailed' — The outbound calling name status.
    - `CreatedTimestamp` string, date-time — The phone number creation timestamp, in ISO 8601 format.
    - `UpdatedTimestamp` string, date-time — The updated phone number timestamp, in ISO 8601 format.
    - `DeletionTimestamp` string, date-time — The deleted phone number timestamp, in ISO 8601 format.
    - `OrderId` string — The phone number's order ID.
    - `Name` string, password — The name of the phone number.
  - `NextToken` string — The token used to return the next page of results.

## Other responses

- `480` — UnauthorizedClientException
- `481` — ForbiddenException
- `482` — BadRequestException
- `483` — NotFoundException
- `484` — ThrottledClientException
- `485` — ServiceUnavailableException
- `486` — ServiceFailureException

---

[API](https://skmtc.net/aws/apis/chime-sdk-voice.md) · [All operations](https://skmtc.net/aws/apis/chime-sdk-voice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/chime-sdk-voice/versions/89ce97d6fad9/schema)