Create an inventory coverage request

GET 
/inventory_coverage

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.

Query Parameters

filter[npa] integer
Example: 318
filter[nxx] integer
Example: 202
filter[administrative_area] string
Example: LA
filter[phone_number_type] string
Possible values: [local, toll_free, national, mobile, landline, shared_cost]
Example: local
filter[country_code] string
Possible values: [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]
Example: US
filter[count] boolean
Example: true
filter[features] string[]

Possible values: [sms, mms, voice, fax, emergency]

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

filter[groupBy] stringrequired
Possible values: [locality, npa, national_destination_code]
Example: nxx

200: Successful response with a list of inventory coverage levels

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

group string

group_type string

number_range integer

number_type string

Possible values: [did, toll-free]

phone_number_type string

Possible values: [local, toll_free, national, landline, shared_cost, mobile]

coverage_type string

Possible values: [number, block]

record_type string

administrative_area string

count integer

advance_requirements boolean

Indicates if the phone number requires advance requirements.

]

meta

object

total_results integer

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

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

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

Request samples

• cURL

---

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

Response samples

• 200
• default

---

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