Search Global Number Inventory by City and Area Code
GET {{baseUrl}}/v1/inventory/didgroup?countryCodeA3=<string>&pageNumber=0&pageSize=20
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
countryCodeA3 | string | Indicates the country code of the DID group in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.). | |
didGroupIds | string | Can be used if you want information about specific DID groups. Note that you can specify multiple ids by repeating the query parameter. | |
stateId | string | The numerical identifier for the didGroup's state. Please see the listState operation to retrieve a valid state identifier. | |
cityNamePattern | string | A string pattern to be matched the city name. The entered string will be searched within any part of the city name. | |
rateCenter | string | The rate center can be defined as a zone (which can be equivalent to a city or the area of a city) e.g. the rate center of 'NEW YORK CITY ZONE 1' would be 'NWYRCYZN01'. The rate center is a notion usually used in north America. | |
areaCode | string | The area code of the DID group (e.g. '646'). | |
didType | string | The type of DID. | |
showEmpty | string | Set to true if you want to show the didGroups with no stock currently available. | |
featureIds | string | Can be used if you want to list DID groups that support certain features such as VoxSMS or VoxFAX. (eg. 6 for VoxFAX, 25 for VoxSMS, 50 for Voice). Note that you can specify multiple features by repeating the query parameter. | |
quantity | string | The quantity of numbers you want to return in your results. | |
consecutive | string | Indicating if you want the numbers returned in your results to consecutive only, or not. (true/false). | |
digits | string | You can search a specific phone number in the Bandwidth inventory with a specific pattern e.g. 123. | |
pageNumber | number | The page number, starting at 0. | |
pageSize | number | The page size (max number of entities that are displayed in the response). |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
apikey | string | Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help. | |
Accept | string |
RESPONSES
status: OK
{"didGroups":[{"didGroupId":6557,"countryCodeA3":"USA","stateId":18,"didType":"GEOGRAPHIC","cityName":"ABBEVILLE","areaCode":"337","rateCenter":"ABBEVILLE","stock":34,"setup100":0,"monthly100":21,"available":true,"regulationRequirement":null,"features":[{"featureId":6,"name":"VoxFax","description":"VoxFax"},{"featureId":50,"name":"Voice","description":"Voice"},{"featureId":51,"name":"VoxOUT International","description":"Used to build the coverage pages in the public website"},{"featureId":5,"name":"T.38","description":"T.38"},{"featureId":29,"name":"VoxOUT Emergency","description":"Feature that allows the VoxDID to access emergency services"},{"featureId":52,"name":"VoxOUT National","description":"Used to build the coverage pages in the public website"},{"featureId":25,"name":"VoxSMS","description":"VoxSMS"}]},{"didGroupId":8371,"countryCodeA3":"USA","stateId":null,"didType":"TOLL_FREE","cityName":null,"areaCode":"888","rateCenter":null,"stock":141,"setup100":0,"monthly100":83,"available":true,"regulationRequirement":null,"features":[{"featureId":6,"name":"VoxFax","description":"VoxFax"},{"featureId":50,"name":"Voice","description":"Voice"},{"featureId":51,"name":"VoxOUT International","description":"Used to build the coverage pages in the public website"},{"featureId":5,"name":"T.38","description":"T.38"},{"featureId":29,"name":"VoxOUT Emergency","description":"Feature that allows the VoxDID to access emergency services"},{"featureId":52,"name":"VoxOUT National","description":"Used to build the coverage pages in the public website"}]}],"resultCount":2}