Skip to Content

Download a CDR File

Download a CDR file of specific extensions or all extensions.

Steps to download a CDR file

  1. Get the download URL of the CDR file
  2. Download the CDR file

Request URL

GET {base_url}/{api_path}/cdr/download?access_token={access_token}

Request parameters

Note:To perform a fuzzy search for the phone number, you can enable the fuzzy search feature using the Edit CDR Options interface.

ParameterRequiredTypeDescription
start_timeNoStringSpecify the start time to filter CDR.
Note:
  • The time can be specified as either an ISO 8601 date-time string or a Unix timestamp (in seconds).

  • If you use the date-time format, it must follow the PBX's date and time display format (set in System > Date and Time > Display Format on PBX).

    Examples:

    • If the display format is Month/Day/Year and is 24-hours format, then the valid time format is MM/DD/YYYY HH:mm:ss.
    • If the display format is Year/Month/Day and is 12-hours format, then the valid time format is YYYY/MM/DD HH:mm:ss AM or YYYY/MM/DD HH:mm:ss PM.
end_timeNoStringSpecify the end time to filter CDR.
Note:
  • The time can be specified as either an ISO 8601 date-time string or a Unix timestamp (in seconds).

  • If you use the date-time format, it must follow the PBX's date and time display format (set in System > Date and Time > Display Format on PBX).

    Examples:

    • If the display format is Month/Day/Year and is 24-hours format, then the valid time format is MM/DD/YYYY HH:mm:ss.
    • If the display format is Year/Month/Day and is 12-hours format, then the valid time format is YYYY/MM/DD HH:mm:ss AM or YYYY/MM/DD HH:mm:ss PM.
call_fromNoStringThe number of caller.
call_toNoStringThe number of callee.
extension_groupNoIntegerThe unique ID of an extension group.
Note: You can query the extension group's ID using Get Menu Options.
disposition_code_listNoStringThe ID(s) of the call disposition code(s) of call notes.
Note:
  • You can query the disposition code ID using the Get Menu Options interface.
  • Use comma to separate multiple disposition code IDs.
call_note_remarkNoStringThe remark of call notes.
statusNoStringcall status.
Valid value:
  • ANSWERED
  • NO ANSWER
  • BUSY
  • FAILED
  • VOICEMAIL
didNoStringSpecify the DID to filter the CDR.

Valid value: 

{did_number}: trunk_name} or 

{did_name}:{trunk_name}

Note:

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
fileStringThe CDR file.
download_resource_urlStringThe CDR download URL.
Note: The download URL is only valid for 30 minutes.

Examples

Request example

Obtain the download URL of the CDR during 05/19/2022 00:00:00-05/19/2022 23:59:59.

Important: If you want to filter CDR by date and time, the format of start_time and end_time MUST follow the date and time display format of your PBX, otherwise the response will not return any CDR records.

GET /openapi/v1.0/cdr/download?access_token=5tQstKGzg0Lt4MGTETC1eDjlzk97IIny&start_time=05/19/2022 00:00:00&end_time=05/19/2022 23:59:59 HTTP/1.1
192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "Cdr-X.7.0.16-download-20220520093856-xdhICiIeubqMAtvP.csv",
    "download_resource_url": "/api/download/Cdr-X.7.0.16-download-20220520093856-xdhICiIeubqMAtvP.csv"
}

Download the CDR file

After obtaining the download URL for the CDR file, combine it with the {base_url} and append the {access_token} parameter. Then, use the complete link to download the desired file.

Download link format

{base_url}/{download_resource_url}?access_token={access_token}

Download link example

https://192.168.5.150:8088/api/download/Cdr-X.7.0.16-download-20220520093856-xdhICiIeubqMAtvP.csv?access_token=5tQstKGzg0Lt4MGTETC1eDjlzk97IIny