Dùng endpoint này để đọc những gì đã diễn ra trong hội thoại: tin nhắn của khách hàng và agent, cùng các sự kiện hội thoại khác.
Yêu cầu
Gửi yêu cầu GET với ID hội thoại trong đường dẫn. Không có body.
| Tham số | Kiểu | Mô tả |
|---|---|---|
cid (đường dẫn) |
string | ID hội thoại. |
start_id (query) |
string | Tùy chọn. ID sự kiện để bắt đầu trang. |
limit (query) |
integer | Tùy chọn. Số sự kiện cần lấy. |
Để đọc tiếp, truyền một ID sự kiện từ kết quả trước làm start_id. Phản hồi không có next_cursor hay tổng số; đừng phân trang bằng offset.
Phản hồi
Yêu cầu thành công trả HTTP 200 cùng một mảng JSON các sự kiện. Không có đối tượng bọc ngoài. Một số trường:
[
{
"id": "event_example",
"account_id": "account_example",
"type": "message_sent",
"created": 1763107200000,
"by": {
"id": "user_example",
"type": "user"
},
"data": {
"message": {
"conversation_id": "conversation_example",
"format": "plaintext",
"text": "Hi, is my order ready?"
}
}
}
]
Coi kết quả rỗng hoặc null là không có sự kiện nào.
Đọc sự kiện đúng cách
- Kiểm tra
typetrước. Không phải sự kiện nào cũng là tin nhắn. Chỉ đọcdata.messagevới sự kiện tin nhắn nhưmessage_sent. - Kiểm tra người gửi.
by.typecho biết khách hàng (user) hay agent (agent) đã thực hiện, vàby.idxác định người đó. - Kiểm tra định dạng. Tin nhắn có thể là văn bản thuần, cây block hoặc chỉ có tệp đính kèm. Xem Định dạng tin nhắn và Tệp đính kèm.
- Loại trùng theo
id. Khi đồng bộ lịch sử với sự kiện webhook, dùngidcủa sự kiện để tránh lưu một tin nhắn hai lần.
created tính bằng mili giây Unix.
Yêu cầu HTTP
Thay YOUR_CID bằng ID hội thoại và YOUR_ACCESS_TOKEN bằng token của bạn. Thêm start_id hoặc limit vào query string khi cần.
GET https://api.subiz.com.vn/4.0/conversations/YOUR_CID/messages
Authorization: Bearer YOUR_ACCESS_TOKEN