Skip to main content

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.

Request

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: [US, CA, GB]

    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

Responses

200: Successful response with a list of inventory coverage levels

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
    count integer
  • ]

  • meta

    object

    total_results integer

default: Unexpected error

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.

  • ]

Loading...