Create an inventory coverage request

Creates an inventory coverage request. If locality, npa or national_destination_code is used in groupBy, and no region or locality filters are used, the whole paginated set is returned.

GET /inventory_coverage

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 inventoryCoverages = await client.inventoryCoverage.list();

console.log(inventoryCoverages.data);

200

{
  "data": [
    {
      "group": "318",
      "group_type": "npa",
      "number_range": 1,
      "number_type": "did",
      "phone_number_type": "local",
      "coverage_type": "number",
      "record_type": "inventory_coverage_group",
      "administrative_area": "NJ",
      "count": 3,
      "advance_requirements": true
    }
  ],
  "meta": {
    "total_results": 25
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[npa], filter[nxx], filter[administrative_area], filter[phone_number_type], filter[country_code], filter[count], filter[features], filter[groupBy]

Show child attributes

Response

200

application/json

Successful response with a list of inventory coverage levels

data · object[]

Show child attributes

meta · object

Show child attributes

Example:

{ "total_results": 25 }