List CDRs with filters

GET {{baseUrl}}/v2/cdr/calls?from=2020-08-01T12:00:00.000&to=2020-09-01T12:00:00.000

Request Params

KeyDatatypeRequiredDescription
fromstringStart of period where CDRs will be retrieved from.
tostringEnd of period where CDRs will be retrieved until.
idstringVoxbone's UUID for this record.
countryCodeA3stringIndicates the country code of 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.).
e164stringThe DID in its E164 format (e.g. “+16469185038”) with the ability to provide multiple E164s.
callTypestringThe grouping for the type of DID.
offsetstringStarting position in the dataset of a particular record where we retrieve a subset of records.
limitstringA limit on the number of records to be returned.
anonymizedstringMask the the last 3 digits of the destination number for OUTBOUND calls due to GDPR regulations.

HEADERS

KeyDatatypeRequiredDescription
apikeystringYour API key that can be generated from the Voxbone Platform.

RESPONSES

status: OK

{"data":[{"id":"\u003cstring\u003e","callType":"\u003cstring\u003e","capacityGroupId":"\u003cinteger\u003e","capacityGroupName":"\u003cstring\u003e","countDidCalls":"\u003cinteger\u003e","currency":"\u003cstring\u003e","destinationCountry":"\u003cstring\u003e","destinationNumber":"\u003cstring\u003e","dialStatus":"\u003cstring\u003e","direction":"\u003cstring\u003e","duration":"\u003clong\u003e","e164":"\u003cstring\u003e","end":"\u003cstring\u003e","endStatus":"\u003cstring\u003e","ip":"\u003cstring\u003e","uri":"\u003cstring\u003e","numberType":"\u003cstring\u003e","onNet":"\u003cboolean\u003e","originCountry":"\u003cstring\u003e","originationNumber":"\u003cstring\u003e","pop":"\u003cstring\u003e","ppe":"\u003cstring\u003e","ppm":"\u003cstring\u003e","result":"\u003cstring\u003e","serviceType":"\u003cstring\u003e","start":"\u003cstring\u003e","totalCost":"\u003cstring\u003e","trunkId":"\u003cinteger\u003e","trunkName":"\u003cstring\u003e","zeroRated":"\u003cboolean\u003e"},{"id":"\u003cstring\u003e","callType":"\u003cstring\u003e","capacityGroupId":"\u003cinteger\u003e","capacityGroupName":"\u003cstring\u003e","countDidCalls":"\u003cinteger\u003e","currency":"\u003cstring\u003e","destinationCountry":"\u003cstring\u003e","destinationNumber":"\u003cstring\u003e","dialStatus":"\u003cstring\u003e","direction":"\u003cstring\u003e","duration":"\u003clong\u003e","e164":"\u003cstring\u003e","end":"\u003cstring\u003e","endStatus":"\u003cstring\u003e","ip":"\u003cstring\u003e","uri":"\u003cstring\u003e","numberType":"\u003cstring\u003e","onNet":"\u003cboolean\u003e","originCountry":"\u003cstring\u003e","originationNumber":"\u003cstring\u003e","pop":"\u003cstring\u003e","ppe":"\u003cstring\u003e","ppm":"\u003cstring\u003e","result":"\u003cstring\u003e","serviceType":"\u003cstring\u003e","start":"\u003cstring\u003e","totalCost":"\u003cstring\u003e","trunkId":"\u003cinteger\u003e","trunkName":"\u003cstring\u003e","zeroRated":"\u003cboolean\u003e"}],"links":[{"rel":"\u003cstring\u003e","href":"\u003cstring\u003e","hreflang":"\u003cstring\u003e","media":"\u003cstring\u003e","deprecation":"\u003cstring\u003e","templated":"\u003cboolean\u003e","title":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"rel":"\u003cstring\u003e","href":"\u003cstring\u003e","hreflang":"\u003cstring\u003e","media":"\u003cstring\u003e","deprecation":"\u003cstring\u003e","templated":"\u003cboolean\u003e","title":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"pagination":{"limit":"\u003cinteger\u003e","offset":"\u003cinteger\u003e","total":"\u003clong\u003e"},"status":"\u003cstring\u003e"}