Query CDR List

Query the CDR list.

Request URL

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

Request parameters


Parameter	Required	Type	Description
page	No	Integer	Define which page is displayed. Note: If this parameter is left blank, the response result will return the first page by default.
page_size	No	Integer	Define how many records per page. Maximum value: 10,000 Note: If this parameter is left blank, the response result will return 10,000 records per page by default.
disposition_code_list	No	String	The 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_remark	No	String	The remark of call notes.
sort_by	No	String	Define the sorting field. Valid value: `id` `uid` `time` `duration` `ring_duration` `talk_duration` `disposition` `src_trunk` `dst_trunk` `call_type` `did_number` `dod_number` `src_addr`
order_by	No	String	Define the display order. Valid value: `asc`: Ascending order. `desc`: Descending order.

Response parameters


Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.
total_number	Integer	The total number of CDR.
data	Array<CDR_Details>	The detailed information of the CDR.

CDR_Details


Parameter	Type	Description
id	Integer	The sequence number of the record.
time	String	The time the call was made or received.
call_from	String	The number and name of the caller.
call_to	String	The number and name of the callee.
timestamp	Integer	The timestamp of the time when the call was made or received.
uid	String	The unique ID of the CDR.
src_addr	String	The IP address of the caller's device.
src_trunk	String	The call was received via which trunk.
dst_trunk	String	The call was sent out via which trunk.
duration	Integer	The time between the call started and the call ended.
ring_duration	Integer	The time between the call started and the call answered.
talk_duration	Integer	The time between the call answered and the call ended.
disposition	String	Call status. `ANSWERED` `NO ANSWER` `BUSY` `FAILED` `VOICEMAIL`
call_type	String	Communication type. `Inbound` `Outbound` `Internal`
did_number	String	The phone number that the caller dialed.
dod_number	String	The phone number that was displayed on the callee's phone.
record_file	String	The name of the call recording file.
reason	String	The reason why the call was ended.
call_from_number	String	The number of the caller.
call_from_name	String	The name of the caller.
call_to_number	String	The number of the callee.
call_to_name	String	The name of the callee.
call_id	String	The unique ID of the call.
call_note	Object<Call_Note>	The call note of the call.
call_note_id	String	The unique ID of the call note.
enb_call_note	Integer	Whether call note can be edited or not. `0`: Call note can not be edited. `Non-zero value`: Call note can be edited.
did	String	The phone number that the caller dialed and the associated name.
did_name	String	The name associated with the phone number that the caller dialed.

Call_Note


Parameter	Type	Description
id	String	The unique ID of the call note.
group_id	String	The group ID of the call note.
disposition_code_list	Array<Disposition_Codes>	The disposition code(s) selected in the call note.
remark	String	The remark of the call note.
agent_name	String	The name of the extension user who adds the call note.
registration_time	Long	The time when the extension user adds the call note.

Disposition_Codes


Parameter	Type	Description
id	Integer	The unique ID of the call disposition code.
name	String	The label of the call disposition code.
description	String	The description of the call disposition code

Examples

Request example

GET /openapi/v1.0/cdr/list?access_token=64er0dvpIUiXhZEetXfvqaEj4XIY2rLj&sort_by=id&order_by=desc HTTP/1.1  
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 5,
    "data": [
        {
            "id": 1,
            "time": "06/18/2024 13:47:33",
            "call_from": "6702",
            "call_to": "Kristin Hale<2005>",
            "timestamp": 1718689653,
            "uid": "20240618134733F8564",
            "src_addr": "120.24.97.161:5060",
            "src_trunk": "with-msg-pce",
            "duration": 16,
            "ring_duration": 13,
            "talk_duration": 3,
            "disposition": "ANSWERED",
            "call_type": "Inbound",
            "did_number": "123456",
            "reason": "dst hangup    ",
            "call_from_number": "6702",
            "call_from_name": "",
            "call_to_number": "2005",
            "call_to_name": "Kristin Hale",
            "call_id": "1718689653.0",
            "call_note": {
                "id": "20240618160214-24CE3",
                "group_id": "1745395229.3",
                "disposition_code_list": [
                {
                    "id": 21,
                    "name": "Transferred to Another Department",
                    "description": "The call was transferred to the appropriate team or department."
                }
            ],
               "remark": "User encountered xx issue, needs resolution from the tech support department",
               "agent_name": "Madison Cooper",
               "registration_time": 1741226653,
               "update_entry": ""
            },
            "call_note_id": "20240618160214-24CE3",
            "enb_call_note": 8,
            "did": "123456",
            "did_name": ""
        },
        {
            "id": 2,
            "time": "06/18/2024 13:48:32",
            "call_from": "6702",
            "call_to": "Kristin Hale<2005>",
            "timestamp": 1718689712,
            "uid": "2024061813483298651",
            "src_addr": "192.168.148.50:65457",
            "src_trunk": "with-msg-pce",
            "duration": 17,
            "ring_duration": 11,
            "talk_duration": 6,
            "disposition": "ANSWERED",
            "call_type": "Inbound",
            "did_number": "123456",
            "reason": "dst hangup    ",
            "call_from_number": "6702",
            "call_from_name": "",
            "call_to_number": "2005",
            "call_to_name": "Kristin Hale",
            "call_id": "1718689712.3",
            "call_note": null,
            "call_note_id": "",
            "enb_call_note": 0,
            "did": "123456",
            "did_name": ""
        },
        {
            "id": 3,
            "time": "06/18/2024 13:48:31",
            "call_from": "6702",
            "call_to": "RingGroup ringback-tone-test-RG<6300>",
            "timestamp": 1718689711,
            "uid": "2024061813483298651",
            "src_addr": "192.168.148.50:65457",
            "src_trunk": "with-msg-pce",
            "duration": 18,
            "ring_duration": 12,
            "talk_duration": 6,
            "disposition": "ANSWERED",
            "call_type": "Inbound",
            "did_number": "123456",
            "reason": "dst connected    ",
            "call_from_number": "6702",
            "call_from_name": "",
            "call_to_number": "6300",
            "call_to_name": "ringback-tone-test-RG",
            "call_id": "1718689712.3",
            "call_note": null,
            "call_note_id": "",
            "enb_call_note": 0,
            "did": "123456",
            "did_name": ""
        },
        {
            "id": 4,
            "time": "06/18/2024 14:08:32",
            "call_from": "Phillip Huff<1002>",
            "call_to": "Kristin Hale<2005>",
            "timestamp": 1718690912,
            "uid": "20240618140832625C1",
            "src_addr": "192.168.28.1",
            "duration": 18,
            "ring_duration": 18,
            "disposition": "BUSY",
            "call_type": "Internal",
            "reason": "dst forwarded    ",
            "call_from_number": "1002",
            "call_from_name": "Phillip Huff",
            "call_to_number": "2005",
            "call_to_name": "Kristin Hale",
            "call_id": "1718690912.7",
            "call_note": null,
            "call_note_id": "",
            "enb_call_note": 0,
            "did": "",
            "did_name": ""
        },
        {
            "id": 5,
            "time": "06/18/2024 14:08:50",
            "call_from": "Phillip Huff<1002>",
            "call_to": "Voicemail Kristin Hale<2005>",
            "timestamp": 1718690930,
            "uid": "20240618140832625C1",
            "src_addr": "192.168.148.50:62746",
            "duration": 10,
            "talk_duration": 10,
            "disposition": "VOICEMAIL",
            "call_type": "Internal",
            "reason": "src hangup    ",
            "call_from_number": "1002",
            "call_from_name": "Phillip Huff",
            "call_to_number": "2005",
            "call_to_name": "Kristin Hale",
            "call_id": "1718690912.7",
            "call_note": null,
            "call_note_id": "",
            "enb_call_note": 0,
            "did": "",
            "did_name": ""
        }
    ]
}