List All Numbers using Channel Billing

Retrieve a list of all phone numbers using Channel Billing, grouped by Zone.

GET /list

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.list.retrieveAll();

console.log(response.data);

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

A list of numbers using GCB, grouped by channel zone

data · object[]

Show child attributes

meta · object

Show child attributes