Skip to main content

Get the list of phone numbers assigned to a channel zone

GET 
/channel_zones/:channel_zone_id/channel_zone_phone_numbers

Retrieve the assigned phone numbers in a channel zone. Phone numbers assigned to a channel zone can receive concurrent calls up to the quantity reserved in that channel zone. Additional concurrent calls are rejected with a busy signal.

Request​

Path Parameters

    channel_zone_id stringrequired

    Channel zone identifier

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses​

200: A list of phone numbers

Schema

    data

    object[]

  • Array [

    • record_type stringrequired

    Possible values: [channel_zone_phone_number]

    channel_zone_id stringrequired
    id string
    phone_number +E.164required
    created_at string

    ISO 8601 formatted date of when the phone number was created

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

Request samples

curl -L 'https://api.telnyx.com/v2/phone_numbers/channel_zones/:channel_zone_id/channel_zone_phone_numbers' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "record_type": "channel_zone_phone_number",
      "channel_zone_id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
      "id": "3da3c749-bb7d-4ad6-acae-ca0d415ae08b",
      "phone_number": "+15554441234",
      "created_at": "2019-01-23T18:10:02.574Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}