Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
CDR (Call History)

Read CDRs for Specific User

get/domains/{domain}/users/{user}/cdrs

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

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

uidstring required
domainstring required
cdr_idstring required
typeinteger required
time_startinteger required
time_answerinteger required
time_releaseinteger required
durationinteger required
orig_to_uristring required
numberstring nullable required
namestring nullable required
onnetinteger required
hideinteger required
tagstring required
expected_traceboolean required