Skip to main content

List Of CDRs

curl -L -X GET 'https://{base_url}/v1/cdr?' \
-H 'Authorization: Bearer {token}'

Pagination response trả về:

{
"data": [
{
"id": "ad4c9b90-c071-405a-9723-980d2e5e1623",
"sip_call_id": "112233aabbccddee..",
"cause": "NORMAL_CLEARING",
"duration": 15,
"billsec": 11,
"direction": 3,
"recording_url": "https://recording.demo/ad4c9b90-c071-405a-9723-980d2e5e1623",
"extension": "101",
"from_number": "19001919",
"to_number": "0899888999",
"receive_dest": "",
"time_started": "2021-02-17 17:30:35",
"time_answered": "2021-02-17 17:30:43",
"time_ended": "2021-02-17 17:30:46",
"status": "ANSWERED"
},
{
"id": "01b7d166-b564-42ec-80a1-4ad343225934 ",
"sip_call_id": "aabbccddee112233..",
"cause": "NORMAL_CLEARING",
"duration": 45,
"billsec": 39,
"direction": 3,
"recording_url": "",
"extension": "101",
"from_number": "19001919",
"to_number": "0899888999",
"receive_dest": "",
"time_started": "2021-02-18 17:20:58",
"time_answered": "",
"time_ended": "2021-02-18 17:21:05",
"status": "BUSY"
},
...
],
"limit": 10,
"page": 1,
"total": 22
}

Scroll response trả về:

{
"data": [
{
"id": "ad4c9b90-c071-405a-9723-980d2e5e1623",
"sip_call_id": "112233aabbccddee..",
"cause": "NORMAL_CLEARING",
"duration": 15,
"billsec": 11,
"duration": 11,
"direction": 3,
"recording_url": "https://recording.demo/ad4c9b90-c071-405a-9723-980d2e5e1623.wav",
"extension": "101",
"from_number": "19001919",
"to_number": "0899888999",
"receive_dest": "",
"time_started": "2021-02-17 17:30:35",
"time_answered": "2021-02-17 17:30:43",
"time_ended": "2021-02-17 17:30:46",
"status": "ANSWERED"
},
{
"id": "01b7d166-b564-42ec-80a1-4ad343225934",
"sip_call_id": "aabbccddee112233..",
"cause": "NORMAL_CLEARING",
"duration": 45,
"billsec": 39,
"direction": 3,
"recording_url": "",
"extension": "101",
"from_number": "19001919",
"to_number": "0899888999",
"receive_dest": "",
"time_started": "2021-02-18 17:20:58",
"time_answered": "",
"time_ended": "2021-02-18 17:21:05",
"status": "BUSY"
},
...
],
"scroll_id": "111222333444aaabbbcccddd=="
}

Trả về danh sách lịch sử cuộc gọi. API CDRs sử dụng 2 cơ chế để trả về dữ liệu. Pagination: Phân trang. Scroll: Cuộn trang. (Mặc định)

Nếu user cung cấp trong param: page - Số trang, limit - số lượng trả về thì API sẽ trả về dữ liêu theo cơ chế Pagination.

HTTP Request

GET https://{base_url}/v1/cdr

Query Parameters

ParameterDescriptionExample
start_dateTìm kiếm cdrs theo khoảng thời gian (Khởi tạo cuộc gọi)2021-02-18 hoặc 2021-02-18 17:20:58
end_dateTìm kiếm cdrs theo khoảng thời gian (Khởi tạo cuộc gọi)2021-02-19 hoặc 2021-02-19 00:00:00
durationThời hạn của cuộc gọi10
min_durationThời hạn thực hiện cuộc gọi ít nhất.5 - sẽ lấy CDR có duration lớn hơn 5 giây
extensionCuộc gọi từ extension nào101
recordingfileFile recording của cuộc gọiabcd.mp3
statusTrạng thái cuộc gọiANSWERED
phoneTừ hoặc tới số điện thoại nào0899888999
directionChiều cuộc gọi (inbound, outbound, local)outbound
start_date_endedTìm kiếm cdrs theo khoảng thời gian (Kết thúc cuộc gọi)2021-02-18 hoặc 2021-02-18 17:20:58
end_date_endedTìm kiếm cdrs theo khoảng thời gian (Kết thúc cuộc gọi)2021-02-19 hoặc 2021-02-19 00:00:00
limitSố lượng record trả về50
pageTrang. (Pagination)1
offsetVị trí bắt đầu khi query. (offset sẽ thay thế page nếu có data) (Pagination)0
scroll_idTruyền vào sau lần query đầu tiên. (Scroll)abc123efsds...