--- title: "Read CDRs" method: GET path: "/cdrs" tags: ["CDR (Call History)"] --- # Read CDRs `GET /cdrs` ## Query parameters - `datetime-start` string, 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-end` string, 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. - `start` number — 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. - `limit` number — 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. - `type` string ## Response `200` - CdrD[] - `id` string, required - `domain` string, required - `reseller` string, required - `call-account-code` string, nullable, required - `call-answer-datetime` string, required - `call-audio-codec` string, required - `call-audio-relay-side-a-local-port` integer, required - `call-audio-relay-side-a-packet-count` integer, required - `call-audio-relay-side-a-remote-ip` string, required - `call-audio-relay-side-b-packet-count` integer, required - `call-audio-relay-side-b-remote-ip` string, required - `call-batch-answer-datetime` string, required - `call-batch-on-hold-duration-seconds` integer, required - `call-batch-sequence-marker` string, required - `call-batch-start-datetime` string, required - `call-batch-total-duration-seconds` integer, required - `call-direction` integer, required - `call-disconnect-datetime` string, required - `call-disconnect-reason-text` string, required - `call-disposition` unknown, required - `call-disposition-notes` unknown, required - `call-disposition-reason` unknown, required - `call-disposition-submitted-datetime` unknown, required - `call-disposition-type` unknown, required - `call-fax-codec` unknown, required - `call-fax-relay-side-a-local-port` unknown, required - `call-fax-relay-side-a-packet-count` unknown, required - `call-fax-relay-side-a-remote-ip` unknown, required - `call-fax-relay-side-b-packet-count` unknown, required - `call-fax-relay-side-b-remote-ip` unknown, required - `call-intelligence-job-id` string, required - `call-intelligence-percent-negative` string, required - `call-intelligence-percent-neutral` string, required - `call-intelligence-percent-positive` string, required - `call-intelligence-topics-top` string, required - `call-leg-ordinal-index` integer, required - `call-on-hold-duration-seconds` integer, required - `call-orig-call-id` string, required - `call-orig-caller-id` integer, required - `call-orig-department` string, required - `call-orig-domain` string, required - `call-orig-from-host` string, required - `call-orig-from-name` string, required - `call-orig-from-uri` string, required - `call-orig-from-user` string, required - `call-orig-ip-address` string, required - `call-orig-match-uri` string, required - `call-orig-pre-routing-uri` string, required - `call-orig-request-host` string, required - `call-orig-request-uri` string, required - `call-orig-request-user` string, required - `call-orig-reseller` string, required - `call-orig-site` string, required - `call-orig-to-host` string, required - `call-orig-to-uri` string, required - `call-orig-to-user` string, required - `call-orig-user` integer, required - `call-parent-call-id` string, required - `call-parent-cdr-id` string, required - `call-record-creation-datetime` unknown, required - `call-ringing-datetime` unknown, required - `call-routing-class` integer, required - `call-routing-match-uri` string, required - `call-start-datetime` string, required - `call-tag` string, required - `call-talking-duration-seconds` integer, required - `call-term-call-id` string, required - `call-term-caller-id` string, required - `call-term-department` unknown, required - `call-term-domain` string, required - `call-term-ip-address` string, required - `call-term-match-uri` string, required - `call-term-pre-reouting-uri` string, required - `call-term-reseller` unknown, required - `call-term-site` unknown, required - `call-term-to-uri` string, required - `call-term-user` unknown, required - `call-through-action` string, required - `call-through-call-id` unknown, required - `call-through-caller-id` unknown, required - `call-through-department` unknown, required - `call-through-domain` unknown, required - `call-through-reseller` unknown, required - `call-through-site` unknown, required - `call-through-uri` unknown, required - `call-through-user` unknown, required - `call-total-duration-seconds` integer, required - `call-video-codec` unknown, required - `call-video-relay-side-a-local-port` unknown, required - `call-video-relay-side-a-packet-count` unknown, required - `call-video-relay-side-a-remote-ip` unknown, required - `call-video-relay-side-b-packet-count` unknown, required - `call-video-relay-side-b-remote-ip` unknown, required - `call-server-mac-address` string, required - `core-server` string, required - `hide-from-results` integer, required - `is-trace-expected` boolean, required - `prefilled-trace-api` string, required - `prefilled-transcription-api` string, required ## Other responses - `400` - `401` - `404` --- [API](https://skmtc.net/ns-api/apis/netsapiens-api-v2.md) · [All operations](https://skmtc.net/ns-api/apis/netsapiens-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ns-api/netsapiens-api-v2/revisions/d37f65b5b886/schema)