Telnyx

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);

{
  "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
  }
}

GET

inventory_coverage

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);

{
  "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

filter[npa]

integer

Filter by npa

filter[nxx]

integer

Filter by nxx

filter[administrative_area]

string

Filter by administrative area

filter[phone_number_type]

enum<string>

Filter by phone number type

Available options:

local,

toll_free,

national,

mobile,

landline,

shared_cost

filter[country_code]

enum<string>

Filter by country. Defaults to US

Available options:

AT,

AU,

BE,

BG,

CA,

CH,

CN,

CY,

CZ,

DE,

DK,

EE,

ES,

FI,

FR,

GB,

GR,

HU,

HR,

IE,

IT,

LT,

LU,

LV,

NL,

NZ,

MX,

NO,

PL,

PT,

RO,

SE,

SG,

SI,

SK,

US

filter[count]

boolean

Include count in the result

filter[features]

enum<string>[]

Filter if the phone number should be used for voice, fax, mms, sms, emergency. Returns features in the response when used.

Available options:

sms,

mms,

voice,

fax,

emergency

Example:

["voice", "sms"]

filter[groupBy]

enum<string>

Filter to group results

Available options:

locality,

npa,

national_destination_code

Response

Successful response with a list of inventory coverage levels

data

object[]

Show child attributes

data.group

string

Example:

"318"

data.group_type

string

Example:

"npa"

data.number_range

integer

Example:

1

data.number_type

enum<string>

Available options:

did,

toll-free

Example:

"did"

data.phone_number_type

enum<string>

Available options:

local,

toll_free,

national,

landline,

shared_cost,

mobile

Example:

"local"

data.coverage_type

enum<string>

Available options:

number,

block

Example:

"number"

data.record_type

string

Example:

"inventory_coverage_group"

data.administrative_area

string

Example:

"NJ"

data.count

integer

Example:

3

data.advance_requirements

boolean

Indicates if the phone number requires advance requirements.

Example:

true

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Create an inventory coverage request

Authorizations

Query Parameters

Response