Inventory Level

Create an inventory coverage request

Changed on

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/inventory_coverage
  • Auth: HTTP bearer

Query parameters

npainteger

Filter by npa

nxxinteger

Filter by nxx

administrative_areastring

Filter by administrative area

phone_number_type'local' | 'toll_free' | 'national' | 'mobile' | 'landline' | 'shared_cost'

Filter by phone number type

country_code'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 by country. Defaults to US

countboolean

Include count in the result

featuresstring[]

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

groupBy'locality' | 'npa' | 'national_destination_code'

Filter to group results

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]

{
  "features": [
    "voice",
    "sms"
  ]
}

Response

Successful response with a list of inventory coverage levels

Example response

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

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status