Qodex.ai

List number inventory

GET {{baseUrl}}/v1/inventory/did?pageNumber=0&pageSize=20

Request Params

KeyDatatypeRequiredDescription
didIdsstringCan be specified to get detailed info about the corresponding DIDs. Note that you can specify multiple ids by repeating the query parameter.
didGroupIdsstringCan be specified to filter your DIDs based on their location or any other info contained in the DID Group. Note that you can specify multiple ids by repeating the query parameter.
e164PatternstringYou can search a specific DID in your inventory with a specific pattern e.g. %25123 (number contains 123). %-sign needs to be escaped using %25
regulationAddressIdstringThis is an ID that you get when creating a regulation address. The DIDs can be filtered by the regulation address on which they are linked.
voiceUriIdstringThe identifier of the voice uri the numbers are mapped to.
faxUriIdstringThe identifier of the fax uri the numbers are mapped to.
smsLinkGroupIdstringThe identifier of the sms link group the numbers are mapped to.
needAddressLinkstringA boolean flag indicating if the numbers need to be linked to an address for regulation purposes.
serviceTypestringThis can be used if you want to filter by service type. The possible values are 'VOX800' for toll-free numbers or 'VOXDID' for geographic or national numbers.
countryCodeA3stringThe country code for the DID in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.).
orderReferencestringIndicates which purchase order the DID was in. You can get a list of orders with the order details (date and status) in the ordering module using the listOrder method.
portingReferencestringThe reference for the numbers' porting request.
deliveryIdstringThe identifier of the pop the numbers are mapped to.
smsOutboundstringAllows you to filter your DIDs that you have enabled for outbound SMS (the feature is only available for accounts that are registered for the SMS outbound service).
webRtcEnabledstringIndicates whether the DID is enabled for WebRTC use (the feature is only available for accounts that are registered for the WebRTC service).
voxoutNationalEnabledstringIndicates whether the DID is enabled for voxoutNational use (the feature is only available for accounts that are registered for the voxoutNational service).
voxoutInternationalEnabledstringIndicates whether the DID is enabled for voxoutInternational use (the feature is only available for accounts that are registered for the voxoutInternational service).
pageNumbernumberThe page number, starting at 0.
pageSizenumberThe page size (max number of entities that are displayed in the response).

HEADERS

KeyDatatypeRequiredDescription
apikeystringAuthentication 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.
Acceptstring

RESPONSES

status: OK

{"dids":[{"areaCode":"\u003cstring\u003e","didId":"\u003cinteger\u003e","e164":"\u003cstring\u003e","type":"\u003cstring\u003e","countryCodeA3":"\u003cstring\u003e","cityName":"\u003cstring\u003e","voiceUriId":"\u003cinteger\u003e","faxUriId":"\u003cinteger\u003e","smsLinkGroupId":"\u003cinteger\u003e","orderReference":"\u003cstring\u003e","channels":"\u003cinteger\u003e","delivery":"\u003cstring\u003e","trunkId":"\u003cinteger\u003e","capacityGroupId":"\u003cinteger\u003e","didGroupId":"\u003cinteger\u003e","regulationAddressId":"\u003cinteger\u003e","srvLookup":"\u003cboolean\u003e","callerId":{"cliFormat":"\u003cstring\u003e","cliValue":"\u003cstring\u003e"},"cliPrivacy":"\u003cstring\u003e","otherOptions":{"t38Enabled":"\u003cstring\u003e","dtmf":"\u003cstring\u003e","dtmfInbandMute":"\u003cstring\u003e","codecs":["\u003cstring\u003e","\u003cstring\u003e"]},"ringback":"\u003cstring\u003e","dnisEnabled":"\u003cstring\u003e","blockOrdinary":"\u003cboolean\u003e","blockCellular":"\u003cboolean\u003e","blockPayphone":"\u003cboolean\u003e","smsOutbound":"\u003cboolean\u003e","webRtc":"\u003cboolean\u003e","voxoutNational":"\u003cstring\u003e","voxoutInternationalEnabled":"\u003cboolean\u003e","cancellationAvailable":"\u003cstring\u003e"},{"areaCode":"\u003cstring\u003e","didId":"\u003cinteger\u003e","e164":"\u003cstring\u003e","type":"\u003cstring\u003e","countryCodeA3":"\u003cstring\u003e","cityName":"\u003cstring\u003e","voiceUriId":"\u003cinteger\u003e","faxUriId":"\u003cinteger\u003e","smsLinkGroupId":"\u003cinteger\u003e","orderReference":"\u003cstring\u003e","channels":"\u003cinteger\u003e","delivery":"\u003cstring\u003e","trunkId":"\u003cinteger\u003e","capacityGroupId":"\u003cinteger\u003e","didGroupId":"\u003cinteger\u003e","regulationAddressId":"\u003cinteger\u003e","srvLookup":"\u003cboolean\u003e","callerId":{"cliFormat":"\u003cstring\u003e","cliValue":"\u003cstring\u003e"},"cliPrivacy":"\u003cstring\u003e","otherOptions":{"t38Enabled":"\u003cstring\u003e","dtmf":"\u003cstring\u003e","dtmfInbandMute":"\u003cstring\u003e","codecs":["\u003cstring\u003e","\u003cstring\u003e"]},"ringback":"\u003cstring\u003e","dnisEnabled":"\u003cstring\u003e","blockOrdinary":"\u003cboolean\u003e","blockCellular":"\u003cboolean\u003e","blockPayphone":"\u003cboolean\u003e","smsOutbound":"\u003cboolean\u003e","webRtc":"\u003cboolean\u003e","voxoutNational":"\u003cstring\u003e","voxoutInternationalEnabled":"\u003cboolean\u003e","cancellationAvailable":"\u003cstring\u003e"}],"resultCount":"\u003cinteger\u003e"}