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

TEXT

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 ) Khai thác trường dữ liệu này nếu trường "call_status" có giá trị là "miss"

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

21

last_user_id

INT

ID chuyên viên cuối cùng nhận cuộc gọi

22

dtmf

TEXT

Dữ liệu phím bấm của khách hàng

23

call_survey

TEXT

Khảo sát khách hàng thông qua kênh thoại. Khi cấu hình theo khảo sát sau cuộc gọi thì sẽ phát ghi âm để khảo sát, KH đánh giá theo nội dung ghi âm bằng cách bấm phím.

24

call_survey_result

TEXT

Dữ liệu kết quả khảo sát

Ví dụ minh họa lấy lịch sử cuộc gọi theo ID cuộc gọi.

Mẫu Postman điển hình trong trường hợp này đang tìm lịch sử cuộc gọi có id "20221008233814-LSKMQKWP-43"

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 minh họa
curl --location \
--globoff 'https://api.caresoft.vn/{{domain}}/api/v1/calls?start_time_to=2022-10-11T10%3A00%3A00Z&phone=0868887835&agent_id=5000&start_time_since=2022-9-11T10%3A00%3A00Z' \
--header 'Authorization: Bearer {{apiToken}}'

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

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
{
    "code": "OK",
    "numFound": 74,
    "calls": [
        {
            "id": 425647,
            "customer_id": 63204960,
            "call_id": "20221008233814-LSKMQKWP-43",
            "caller": "0868887835",
            "called": "1068",
            "service_id":"100155",
            "user_id": "1",
            "agent_id": "5000",
            "group_id": 1,
            "call_type": 0,
            "start_time": "2022-10-08 23:38:14",
            "call_status": "miss",
            "end_time": "2022-10-08 23:38:29",
            "wait_time": "00:00:15",
            "hold_time": "00:00:00",
            "talk_time": "00:00:00",
            "end_status": "cus",
            "ticket_id": 315053,
            "last_agent_id": "5000",
            "last_user_id": 1,
            "call_survey": "NO",
            "call_survey_result": null,
            "missed_reason": "missed_customer"
        },{
            "id": 425885,
            "customer_id": 29370843,
            "call_id": "20221104143655-LSKMQKWP-268",
            "path": "https://caresoft.vn:19991/f/b6a0d15a9cf87c6cef402e5131f24f6b//6364c13c7569dc76dc5ee57e/6b0e12c9b3304d8e787****194/4bae18d9c8a3ab403210ae724b8f37ab.mp3",
            "path_download": "https://caresoft.vn:19991/f/b6a0d15a9cf87c6cef402e5131f24f6b//6364c13c7569dc76dc5ee57e/cd0490cefca753*****9/4bae18d9c8a3ab403210ae78f37ab.mp3",
            "caller": "0901774143",
            "called": "1066",
            "service_id":"100155",
            "user_id": "63150156",
            "agent_id": "1444",
            "group_id": 65,
            "call_type": 0,
            "start_time": "2022-11-04 14:36:55",
            "call_status": "meetAgent",
            "end_time": "2022-11-04 14:37:19",
            "wait_time": "00:00:01",
            "hold_time": "00:00:00",
            "talk_time": "00:00:23",
            "end_status": "system",
            "ticket_id": 317946,
            "last_agent_id": "1444",
            "last_user_id": 63150156,
            "call_survey": "NO",
            "call_survey_result": null,
            "missed_reason": null
        },

        ...
      ]
    }

Last updated