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
- application/json
default: Unexpected error
- application/json
Loading...