Skip to main content
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);
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
inventory_coverages = client.inventory_coverage.list()
print(inventory_coverages.data)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
inventoryCoverages, err := client.InventoryCoverage.List(context.TODO(), telnyx.InventoryCoverageListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", inventoryCoverages.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.inventorycoverage.InventoryCoverageListParams;
import com.telnyx.sdk.models.inventorycoverage.InventoryCoverageListResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

InventoryCoverageListResponse inventoryCoverages = client.inventoryCoverage().list();
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

inventory_coverages = telnyx.inventory_coverage.list

puts(inventory_coverages)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$inventoryCoverages = $client->inventoryCoverage->list(
filter: [
'administrativeArea' => 'administrative_area',
'count' => true,
'countryCode' => 'AT',
'features' => ['voice', 'sms'],
'groupBy' => 'locality',
'npa' => 0,
'nxx' => 0,
'phoneNumberType' => 'local',
],
);

var_dump($inventoryCoverages);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx inventory-coverage list \
--api-key 'My API Key'
curl --request GET \
--url https://api.telnyx.com/v2/inventory_coverage \
--header 'Authorization: Bearer <token>'
{
  "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
  }
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "Could not understand the provided credentials.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}

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]

Response

Successful response with a list of inventory coverage levels

data
object[]
meta
object
Example:
{ "total_results": 25 }