Cuộc gọi
API lấy lịch sử cuộc gọi điện thoại trên nền tảng CareSoft.
Lịch sử cuộc gọi
Api truy xuất lịch sử cuộc gọi điện thoại trên nền tảng CareSoft.
Thông tin trường dữ liệu của cuộc gọi
Stt | Tên trường | Kiểu | |
---|---|---|---|
1 | call_id | STRING | ID cuộc gọi, duy nhất trên toàn hệ thống |
2 | caller | STRING | Người gọi |
3 | called | STRING | Người nghe |
4 | user_id | INT | ID chuyên viên |
5 | agent_id | INT | Số IP phone của chuyên viên |
6 | group_id | INT | Id của bộ phận của chuyên viên |
7 | call_type | INT | Kiểu cuộc gọi có 2 giá trị 0 hoặc 1 |
8 | start_time | DATETIME | Thời điểm bắt đầu |
9 | end_time | DATETIME | Thời điểm kết thúc |
10 | call_status | STRING | Tình trạng cuộc gọi có 2 giá trị miss, metAgent |
11 | wait_time | TIME | Thời gian chờ nhận cuộc gọi |
12 | hold_time | TIME | Thời gian giữ máy (khi chuyên viên bấm Hold) |
13 | talk_time | TIME | Thời giam đàm thoại |
14 | end_status | INT | Trạng thái kết thúc, có 2 giá trị "cus", system" |
15 | ticket_id | INT | ID phiếu ghi |
16 | missed_reason | STRING | Trạng thái nhỡ có 4 trạng thái (missed_customer , missed_agent_device , missed_agent_reject , missed_agent_timeout ) |
17 | last_agent_id | INT | Chuyên viên cuối cùng nhận cuộc gọi |
18 | path | URL | Đường dẫn file ghi âm (streaming) |
19 | path_download | URL | Đường dẫn file ghi âm (dùng để tải về) |
20 | service_id | INT | Id dịch vụ thoại trên CareSoft |
Ví dụ minh họa lấy lịch sử cuộc gọi theo ID cuộc gọi.
Ví dụ minh họa lấy lịch sử cuộc gọi theo số điện thoại của khách của 1 chuyên viên
Mẫu curl trên tìm danh sách cuộc gọi cho số máy 0868887835 của chuyên viên có iphone= 5000, Có thời điểm bắt đầu gọi trong khoảng thời gian từ 2022-08-11 tới 2022-10-11
Lưu ý: Một thuật toán tối ưu lệnh tìm kiếm phiếu ghi sẽ được thực hiện theo mô hình sau
Khi gọi API không cung cấp khoảng ngày kết thúc (chỉ truyền ngày bắt đầu: start_time_since hoặc end_time_since). Mà ngày bắt đầu trước ngày hiện tại hơn 31 ngày thì hệ thống sẽ tự động chọn khoảng ngày kết thúc là ngày hiện tại và trả về kết quả trong 31 ngày tính từ ngày hiện tại. Nếu ngày bắt đầu nhỏ hơn ngày hiện tại dưới 31 ngày thì hệ thống giữ nguyên ngày bắt đầu và tiến hành lọc dữ liệu theo tham số trên
Khi gọi API cung cấp khoảng ngày kết thúc (param: start_time_to hoặc end_time_to). Mà ngày kết thúc sau ngày bắt đầu quá 31 ngày thì hệ thống tự chọn lại khoảng ngày bắt đầu bằng ngày kết thúc - 31 ngày
Khi gọi API cung cấp cả hai tham số Bắt đầu và Kết thúc cách nhau không quá 31 ngày thì hệ thống lọc phiếu ghi theo giá trị truyền vào này và trả về kết quả tương ứng.
Trong trường hợp cặp điều kiện start_time_since và end_time_since đều được cung cấp hệ thống sẽ ưu tiên xử lý theo điều kiện end_time_since
(Nội dung sẽ Áp dụng từ 02/03/2024)
Api lấy lịch sử cuộc gọi
GET
{domain}/api/v1/calls
Lưu ý: Trong trường hợp cần lấy thông tin cuộc gọi trượt qua nhánh IVR thì sử dụng parameter call_type:3
để lọc dữ liệu.
Query Parameters
Name | Type | Description |
---|---|---|
start_time_since | DateTime | Thời gian bắt đầu cuộc gọi từ Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ) |
call_id | String | ID cuộc gọi của caresoft |
start_time_to | DateTime | Thời gian bắt đầu cuộc gọi tới Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ) |
end_time_since | DateTime | Thời gian kết thúc cuộc gọi từ Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ) |
end_time_to | DateTime | Thời gian kết thúc cuộc gọi tới Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ) |
call_type | Int | Kiểu cuộc gọi có 3 giá trị 0 hoặc 1 hoặc 3 |
call_status | String | Tình trạng cuộc gọi có 2 giá trị miss, metAgent |
phone | String | Số điện thoại của khách hàng |
page | Int | Trang số |
count | Int | Số lượng bản ghi / trang (tối đa 500) |
agent_id | Int | Số ipPhone của chuyên viên |
order_by | String | Sắp xếp dữ liệu |
order_type | String | Kiểu sắp xếp. Là 1 trong 2 giá trị |
service_id | Int | Id dịch vụ trên caresoft |
Headers
Name | Type | Description |
---|---|---|
** | String |
Last updated