Chat

Api lịch sử LiveChat, Messenger, Zalo

Tài liệu lấy dữ liệu lịch sử chat trên hệ thống CareSoft

LƯU Ý: Trong trường hợp không truyền tham số conversation_type thì hệ thống chỉ lọc lịch sử LIVE chat

STT	Tên trường	Chú thích
1	ticket_id	ID phiếu ghi
2	ticket_no	Số phiếu ghi
3	customer_id	ID khách hàng, tương ứng với {{contactId}} khi cần truy xuất thông tin chi tiết của khách
4	cus_email	Email của khách
5	cus_name	Họ tên khách hàng
6	cus_phone	Số điện thoại của khách
7	meet_time	Thời điểm khết nối
8	waitTime	Thời gian chờ
9	answer_time	Thời gian trả lời
10	ring_time	Thời gian chờ rung chuông
11	chat_status	Trạng thái chat LBL_CHAT_STATUS_MISS: Nhỡ LBL_CHAT_STATUS_MEET: Gặp
12	conversation_id	ID phiên chat
13	landing_page	Trang web chứa chat widget (Đối với live chate)
14	referrer	Trang web trước đó link tới landing page
15	is_trigger	Trạng thái kích hoạt trigger: LBL_CHAT_CUSTOMER_REQUEST_TRIGGER LBL_CHAT_CUSTOMER_REQUEST_NORMAL
16	facebook_page_id	Facebook page ID
17	start_time	Thời điểm bắt đầu
18	end_time	Thời điểm kết thúc
19	chat_duration	Thời lượng chat
20	agent_email	Email của chuyên viên
21	agent_name	Tên chuyên viên
22	group_name	Bộ phận của chuyên viên
23	service_id	ID Dịch vụ

Lịch sử chat

Danh sách lịch sử chat

GET {{domain}}/api/v1/chats

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)
assignees	array[int]	Mảng ID nhân viên xử lý, xem thêm ở Chuyên viên
groups	array[int]	Mảng ID bộ phận xem thêm ở Bộ phận
ticket_id	Int	ID phiếu ghi
conversation_type	Int	Loại chat có 3 tham số 0: Livechat 1: Inbox Facebook 3: Zalo Mặc định: 0
chat_status	Int	Tình trạng hội thoại: 0: Nhỡ 1: Gặp
chat_type	Int	Loại hội thoại Có 2 giá trị 0: Hội thoại đến 1: Hội thoại chủ động ra
end_time_to	DateTime	Thời gian bắt đầu cuộc gọi từ Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)
end_time_since	DateTime	Thời gian bắt đầu cuộc gọi từ Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)
start_time_to	DateTime	Thời gian bắt đầu cuộc gọi từ Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)
customers	array[int]	Mảng ID danh sách khách hàng
services	Int	ID dịch vụ
page	Int	Trang
count	Int	Số bản ghi trên /trang (Luôn kèm theo param page) Tối đa 500

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

200: OK Thành công

Kết quả điển hình

{
    "code": "OK",
    "numFound": 34,
    "chats": [
        {
            "ticket_id": 387229101,
            "ticket_no": 7415,
            "customer_id": 165644057,
            "group_name": "AGENT",
            "conversation_id": "20230422094830-AIVGTIVI-503996",
            "cus_email": "",
            "cus_name": "cstest",
            "cus_phone": "",
            "start_time": "2023-04-22 09:48:30",
            "end_time": "2023-04-22 09:49:10",
            "chat_duration": 39,
            "agent_email": "[e-mail]",
            "agent_name": "dungntt",
            "ring_time": "2023-04-22 09:48:30",
            "meet_time": "2023-04-22 09:48:39",
            "waitTime": "00:00:08",
            "answer_time": "00:00:31",
            "chat_status": "LBL_CHAT_STATUS_MEET",
            "landing_page": null,
            "referrer": null,
            "is_trigger": "LBL_CHAT_CUSTOMER_REQUEST_NORMAL",
            "facebook_page_id": null,
            "service_id": 60047005
        },
        ...
        ]
}

Mô tả kết quả

Stt	Tên trường	Chú thích
1	code	Trạng thái thành công: ok: Thành công errors: Thất bại
2	numFound	Số bản ghi tìm thấy theo điều kiện lọc
3	chats []	Mảng dữ liệu danh sách lịch sử chat (xem phía dưới)

Chi tiết 1 đối tượng Chat trong mảng chats

STT	Tên trường	Chú thích
1	ticket_id	ID phiếu ghi
2	ticket_no	Số phiếu ghi
3	customer_id	ID khách hàng, tương ứng với {{contactId}} khi cần truy xuất thông tin chi tiết của khách
4	cus_email	Email của khách
5	cus_name	Họ tên khách hàng
6	cus_phone	Số điện thoại của khách
7	meet_time	Thời điểm khết nối
8	waitTime	Thời gian chờ
9	answer_time	Thời gian trả lời
10	ring_time	Thời gian chờ rung chuông
11	chat_status	Trạng thái chat LBL_CHAT_STATUS_MISS: Nhỡ LBL_CHAT_STATUS_MEET: Gặp
12	conversation_id	ID phiên chat
13	landing_page	Trang web chứa chat widget (Đối với live chate)
14	referrer	Trang web trước đó link tới landing page
15	is_trigger	Trạng thái kích hoạt trigger: LBL_CHAT_CUSTOMER_REQUEST_TRIGGER LBL_CHAT_CUSTOMER_REQUEST_NORMAL
16	facebook_page_id	Facebook page ID
17	start_time	Thời điểm bắt đầu
18	end_time	Thời điểm kết thúc
19	chat_duration	Thời lượng chat
20	agent_email	Email của chuyên viên
21	agent_name	Tên chuyên viên
22	group_name	Bộ phận của chuyên viên
23	service_id	ID Dịch vụ

Để lấy nội dung chat vui lòng truy xuất Chi tiết phiếu ghi đi kèm để lấy thông tin

403: Forbidden

400: Bad Request

500: Internal Server Error