List Numbers using Channel Billing

GET 
/list/:zone_id

Retrieve a list of phone numbers using Channel Billing, grouped by Zone. You can optionally provide a Zone ID to filter the numbers within a specific Zone.

Path Parameters

channel_zone_id string

Channel zone identifier

200: A list of numbers using GCB, grouped by channel zone

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

zone_name string

zone_id string

number_of_channels integer

numbers

object[]

Array [

number string

country string

]

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "zone_name": "Euro channel zone",
      "zone_id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
      "number_of_channels": 7,
      "numbers": [
        {
          "number": "+15554441234",
          "country": "FR"
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Request samples

• cURL

---

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

Response samples

• 200

---

{
  "data": [
    {
      "zone_name": "Euro channel zone",
      "zone_id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
      "number_of_channels": 7,
      "numbers": [
        {
          "number": "+15554441234",
          "country": "FR"
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}