Danh sách tin nhắn chat

API lấy danh sách tin nhắn chat theo từng kênh

Lấy chi tiết danh sách tin nhắn chat

Từ lịch sử Chat nhà phát triển có thể lấy thêm nội dung chat chi tiết theo API dưới đây.

Lưu ý: API bị giới hạn lọc trong khoảng thời gian 31 ngày, tham số start_time_since là tham số bắt buộc, start_time_to không truyền sẽ lấy ngày hiện tại. start_time_since và start_time_to không quá 30 ngày.

Trường hợp không truyền tham số conversation_type. Hệ thống mặc định là lịch sử tin nhắn live chat (tương đương conversation_type=0)

Bảng mô tả các tham số trả về từ CareSoft

Stt

Trường dữ liệu

Mô tả

code

Trạng thái ok: Thành công errors: Thất bại

numFound

Số lượng bản ghi tìm thấy

chats

Mảng danh sách các tin nhắn trao đổi thỏa mãn điều kiện tìm kiếm

Bảng mô tả chi tiết dữ liệu trong mảng "chats"

Stt

Trường dữ liệu

Mô tả

conversation_id

ID phiên chat

conversation_type

Loại chat 0: Live Chat 1: Messenger và Instagram 3: Zalo

msg_id

Message ID

content

Nội dung chat. Nội dung này là dạng text thuần hoặc object JSON phụ thuộc vào trường "type" phía dưới

type

Kiểu nội dung 1. Văn bản 2. Object json file đính kèm 3. Văn bản do hệ thống sinh ra 4. Object Json template (template_type: buttons, generic, reply_to, transaction_order, promotion) Lưu ý: Kiểu nội dung sẽ quyết định phần content là JSON OBJECT hoặc text thuần

time

Thời điểm phát sinh đoạn tin chat

message_index

Thứ tự đoạn chat trong hội thoại. Một phiên chat (conversation) có nhiều mẩu tin chat qua lại các mẩu tin này sẽ đánh index với tham số message_index từ nhỏ đến lớn để biết được time_line của phiên chat và trình tự các mẩu tin chat)

service_id

ID dịch vụ của phiên chat

start_time

Thời điểm bắt đầu phiên chat

sender_agent_name

Tên chuyên viên gửi tin (Null là khách gửi hoặc hệ thống gửi / Cần ghép với type để loại bỏ tin hệ thống)

sender_agent_id

ID chuyên viên gửi tin (Null là khách gửi hoặc hệ thống gửi / Cần ghép với type để loại bỏ tin hệ thống)

sender_visitor_name

Tên khách gửi tin (Null là chuyên viên hoặc hệ thống gửi / Cần ghép với type để loại bỏ tin hệ thống)

sender_visitor_id

Id khách gửi tin (Null là chuyên viên hoặc hệ thống gửi / Cần ghép với type để loại bỏ tin hệ thống)

last_agent_user_id

ID của chuyên viên xử lý phiên chat

ticket_id

ID phiếu ghi liên quan

requester_id

ID Khách hàng hình thành trên hệ thống CareSoft

oa_name (*)

Zalo OA của tin nhắn. Chỉ có khi conversation_type=3

oa_id (*)

Zalo OA ID của tin nhắn Chỉ có khi conversation_type=3

page_name (**)

Tên trang Facebook/Instagram khách chat vào. Chỉ có khi conversation_type=1

page_id (**)

ID trang Facebook/Instagram khách chat vào. Chỉ có khi conversation_type=1

platform (**)

Nền tảng chat vào. Chỉ có khi conversation_type=1 Có các giá trị: - MESSENGER: Tin nhắn Inbox Facebook - INSTAGRAM: Tin nhắn Instagram

(*) Chỉ có khi conversation_type=3 (**) Chỉ có khi conversation_type=1

Cấu hình postman mô phỏng ví dụ

Mẫu dữ liệu trả về

{
    "code": "ok",
    "numFound": 18,
    "chats": [
        {   "conversation_id": "20230822134203-ZGDMRWGB-77677",
            "id": 799734999,
            "msg_id": "20230822134203-ZGDMRWGB-77677;1692686523409",
            "message_index": 2,
            "content": "Admin đã thoát hội thoại",
            "time": "2023-08-22 13:55:19",
            "service_id": 62062484,
            "start_time": "2023-08-22 13:54:51",
            "sender_agent_name": null,
            "sender_agent_id": null,
            "sender_visitor_name": null,
            "sender_visitor_id": null,
            "last_agent_user_id": 124734559,
            "ticket_id": 421360514,
            "type": 3,
            "conversation_type": 3,
            "requester_id": 174137179,
            "oa_name": "CareSoft Test",
            "oa_id": "1600195475413752846"
            ...
        },
        ....
        ]
}

API lấy danh sách chi tiết chat

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

API lấy danh sách các đoạn tin chat chi tiết

Query Parameters

Name

Type

Description

start_time_since*

DatetimeTZ

Thời gian bắt đầu phiên chat từ Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)

start_time_to

DatetimeTZ

Thời gian bắt đầu phiên chat tới Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)

conversation_type

Int

Loại tin nhắn. 0: Live Chat (Mặc định) 1: Messenger/Instagram 3: Zalo

conversation_id

String

Id phiên chat. Trong trường hợp trường này có giá trị thì hệ thống sẽ bỏ qua param conversation_type

requester_id

Int

ID khách hàng

last_agent_user_id

Int

Id chuyên viên xử lý phiên chat

services

Int

ID dịch vụ

count

Int

Số bản ghi trên 1 lần request (tối đa 500), Mặc định 50

page

Int

Số trang dữ liệu request (Mặc định 1)

Headers

Name

Type

Description

***

String

Mẫu phản hồi loại Facebook

{
    "code": "ok",
    "numFound": 31,
    "chats": [
        {
            "conversation_id": "20230822091139-ZGDMRWGB-54470",
            "id": 800076376,
            "msg_id": "20230822091139-ZGDMRWGB-54470;1692705699685",
            "message_index": 1000,
            "content": "Vui lòng đánh giá chúng tôi nhé",
            "time": "2023-08-22 19:01:40",
            "service_id": 61050371,
            "start_time": "2023-08-22 09:11:39",
            "sender_agent_name": "Facebook Survey: Mời bạn đáng giá",
            "sender_agent_id": -2,
            "sender_visitor_name": null,
            "sender_visitor_id": null,
            "last_agent_user_id": 139409084,
            "ticket_id": 421299776,
            "type": 1,
            "conversation_type": 1,
            "requester_id": 175278174,
            "page_name": "Lien xinh",
            "page_id": "100244086089719",
            "platform": "MESSENGER"
        },
        ....
        ]
    }

Mẫu phản hồi Live chat

{
    "code": "ok",
    "numFound": 11,
    "chats": [
        {
            "conversation_id": "20230822165535-ZGDMRWGB-96844",
            "id": 799984961,
            "msg_id": "20230822165535-ZGDMRWGB-96844;1692698135525",
            "message_index": 3,
            "content": "đâsd đã thoát hội thoại",
            "time": "2023-08-22 17:30:19",
            "service_id": 60043410,
            "start_time": "2023-08-22 16:55:36",
            "sender_agent_name": null,
            "sender_agent_id": null,
            "sender_visitor_name": null,
            "sender_visitor_id": null,
            "last_agent_user_id": 124734559,
            "ticket_id": 421443464,
            "type": 3,
            "conversation_type": 0,
            "requester_id": 176584437
        },
        ....
        ]
    }

Mẫu phản hồi Zalo

{
    "code": "ok",
    "numFound": 18,
    "chats": [
        {
            "conversation_id": "20230822134203-ZGDMRWGB-77677",
            "id": 799734999,
            "msg_id": "20230822134203-ZGDMRWGB-77677;1692686523409",
            "message_index": 2,
            "content": "Admin đã thoát hội thoại",
            "time": "2023-08-22 13:55:19",
            "service_id": 62062484,
            "start_time": "2023-08-22 13:54:51",
            "sender_agent_name": null,
            "sender_agent_id": null,
            "sender_visitor_name": null,
            "sender_visitor_id": null,
            "last_agent_user_id": 124734559,
            "ticket_id": 421360514,
            "type": 3,
            "conversation_type": 3,
            "requester_id": 174137179,
            "oa_name": "CareSoft Test",
            "oa_id": "1600195475413752846"
        },
        ....
        ]
    }

Lỗi ngày tháng truyền vào quá 31 ngày

{
    "code": "errors",
    "message": "Request required [start_time_since/start_time_to] between 30 days "
}

Lỗi không tìm thấy last_agent_user_id từ param truyền vào

{
    "code": "errors",
    "message": "Not found last_agent_user_id: 1121212 "
}

Lỗi không tìm thấy khách hàng từ param truyền vào

{
    "code": "errors",
    "message": "Not found requester_id: 1 "
}

PreviousChat NextCuộc gọi

Last updated 1 year ago