v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

CDR (Call History)

Read CDRs

get/cdrs

Query parameters

datetime-startstring rfc3339 required

This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.

Supported formats include.

2023-11-27 13:00:00
2023-11-27T13:00:00Z
2023-11-27T13:00:00-08:00
2023-11-27T13:00:00-08:00[US/Pacific]
2023-11-27T13:00:00Z[America/Phoenix]

datetime-endstring rfc3339 required

This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.

startnumber

This is the start value when using pagination. 0 is the default and the minimum value. For example the default of 0 paired with the default limit of 100 would return the first 100 objects in the data request. A start of 100 and a default limit of 100 would give you the second 100 results in the response.

limitnumber

This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start.

typestring

Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3

Response

idstring required

domainstring required

resellerstring required

call-account-codestring nullable required

call-answer-datetimestring required

call-audio-codecstring required

call-audio-relay-side-a-local-portinteger required

call-audio-relay-side-a-packet-countinteger required

call-audio-relay-side-a-remote-ipstring required

call-audio-relay-side-b-packet-countinteger required

call-audio-relay-side-b-remote-ipstring required

call-batch-answer-datetimestring required

call-batch-on-hold-duration-secondsinteger required

call-batch-sequence-markerstring required

call-batch-start-datetimestring required

call-batch-total-duration-secondsinteger required

call-directioninteger required

call-disconnect-datetimestring required

call-disconnect-reason-textstring required

{"stackTrail":"components:schemas:CdrD:properties:call-disposition","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-disposition-notes","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-disposition-reason","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-disposition-submitted-datetime","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-disposition-type","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-fax-codec","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-fax-relay-side-a-local-port","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-fax-relay-side-a-packet-count","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-fax-relay-side-a-remote-ip","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-fax-relay-side-b-packet-count","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-fax-relay-side-b-remote-ip","oasType":"schema","type":"unknown"}

call-intelligence-job-idstring required

call-intelligence-percent-negativestring required

call-intelligence-percent-neutralstring required

call-intelligence-percent-positivestring required

call-intelligence-topics-topstring required

call-leg-ordinal-indexinteger required

call-on-hold-duration-secondsinteger required

call-orig-call-idstring required

call-orig-caller-idinteger required

call-orig-departmentstring required

call-orig-domainstring required

call-orig-from-hoststring required

call-orig-from-namestring required

call-orig-from-uristring required

call-orig-from-userstring required

call-orig-ip-addressstring required

call-orig-match-uristring required

call-orig-pre-routing-uristring required

call-orig-request-hoststring required

call-orig-request-uristring required

call-orig-request-userstring required

call-orig-resellerstring required

call-orig-sitestring required

call-orig-to-hoststring required

call-orig-to-uristring required

call-orig-to-userstring required

call-orig-userinteger required

call-parent-call-idstring required

call-parent-cdr-idstring required

{"stackTrail":"components:schemas:CdrD:properties:call-record-creation-datetime","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-ringing-datetime","oasType":"schema","type":"unknown"}

call-routing-classinteger required

call-routing-match-uristring required

call-start-datetimestring required

call-tagstring required

call-talking-duration-secondsinteger required

call-term-call-idstring required

call-term-caller-idstring required

{"stackTrail":"components:schemas:CdrD:properties:call-term-department","oasType":"schema","type":"unknown"}

call-term-domainstring required

call-term-ip-addressstring required

call-term-match-uristring required

call-term-pre-reouting-uristring required

{"stackTrail":"components:schemas:CdrD:properties:call-term-reseller","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-term-site","oasType":"schema","type":"unknown"}

call-term-to-uristring required

{"stackTrail":"components:schemas:CdrD:properties:call-term-user","oasType":"schema","type":"unknown"}

call-through-actionstring required

{"stackTrail":"components:schemas:CdrD:properties:call-through-call-id","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-through-caller-id","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-through-department","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-through-domain","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-through-reseller","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-through-site","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-through-uri","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-through-user","oasType":"schema","type":"unknown"}

call-total-duration-secondsinteger required

{"stackTrail":"components:schemas:CdrD:properties:call-video-codec","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-video-relay-side-a-local-port","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-video-relay-side-a-packet-count","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-video-relay-side-a-remote-ip","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-video-relay-side-b-packet-count","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CdrD:properties:call-video-relay-side-b-remote-ip","oasType":"schema","type":"unknown"}

call-server-mac-addressstring required

core-serverstring required

hide-from-resultsinteger required

is-trace-expectedboolean required

prefilled-trace-apistring required

prefilled-transcription-apistring required