v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

CDR (Call History)

Count CDRs and SUM minutes for Domain

get/domains/{domain}/cdrs/count

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

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.

typestring

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

Response

totalinteger required