Trò chuyện và tin nhắn
Phương pháp API để tìm nạp siêu dữ liệu cuộc trò chuyện ChatHub, quản lý trạng thái và xem lại chuỗi tin nhắn lịch sử.
URL: https://chatapi.smsbat.com
1. Nhận tất cả các cuộc trò chuyện
Tìm nạp danh sách các cuộc trò chuyện bằng tính năng lọc và phân trang động.
Yêu cầu
- Phương pháp: NHẬN
- URL: /api/chat/chats
- Ủy quyền: Mã thông báo mang (Bắt buộc)
Tham số truy vấn
| Tham số | Loại | Mô tả |
|---|---|---|
trang |
số nguyên |
Số trang. Mặc định: 1 |
mỗi_trang |
số nguyên |
Các mục trên mỗi trang. Mặc định: 20 |
tìm kiếm |
chuỗi |
Tìm kiếm văn bản (ví dụ: tên, số điện thoại) |
nguồn |
số nguyên |
Enum nguồn trò chuyện (ví dụ: 1 cho Viber Bot, 2 cho Telegram) |
ngày |
ngày giờ |
Tìm nạp các cuộc trò chuyện giữa hai ngày (yêu cầu hai khóa tham số giống hệt nhau trong URL). Ví dụ: ?date=2026-01-28&date=2026-01-29 |
tg_user_id |
số nguyên |
ID người dùng Telegram |
điện thoại |
chuỗi |
Số điện thoại |
trạng thái |
số nguyên |
0 = Mới, 1 = Mở, 2 = Đang chờ, 3 = BậtPause, 4 = Đã đóng |
Id tổ chức |
số nguyên |
Thu hẹp theo tổ chức |
Id toán tử |
số nguyên |
Thu hẹp theo nhà điều hành được chỉ định |
Phản hồi (200 OK)
{
"total": 124,
"items": [
{
"id": 123,
"theme": "Support Ticket #491",
"operator": {
"id": 21,
"name": "Jane",
"photo": "url_to_photo.png"
},
"chatStatus": 1,
"countUnread": 3
}
]
}
2. Thay đổi trạng thái trò chuyện
Cập nhật trạng thái được chỉ định của một phiên trò chuyện cụ thể.
Yêu cầu
- Phương pháp: ĐẶT
- URL: /api/chat/status
- Ủy quyền: Mã thông báo mang
- Tiêu đề: Content-Type: application/json
Thân thể:
Giá trị Enum trạng thái:
- 0: Mới (Tạo mới)
- 1: Mở (Người vận hành chủ động xử lý)
- 2: Đang chờ (Đang chờ phản hồi của người dùng)
- 3: OnPause (Trạng thái tạm dừng)
- 4: Đã đóng (Đã lưu trữ)
3. Xóa cuộc trò chuyện
Xóa vĩnh viễn một cuộc trò chuyện thông qua ID duy nhất của nó.
Yêu cầu
- Phương pháp: XÓA
- URL: /api/chat/chats/{id}
- Ủy quyền: Mã thông báo mang
Phản hồi (200 OK)
Trả về HTTP 200 để xác nhận xóa thành công. Nội dung thường trống hoặc hoàn toàn "OK".
4. Truy xuất tin nhắn trò chuyện
Loại bỏ tất cả tin nhắn đã gửi và nhận trong lịch sử trong một cuộc trò chuyện cụ thể.
Yêu cầu
- Phương pháp: NHẬN
- URL: /api/chat/chats/{chatId}/messages
- Ủy quyền: Mã thông báo mang
Phản hồi (200 OK)
[
{
"id": 1,
"chatId": 123,
"message": "Hello, how can I help?",
"phone": "380936670003",
"author": 0,
"status": 3,
"date": "2025-04-01T09:46:24.687Z",
"operator": {
"id": 21,
"name": "Jane"
},
"messageType": 0
}
]
0: Toán tử
- 1: Khách hàng
- 2: Bot hệ thống
- 3: Tài khoản Viber Business
Loại tin nhắn:
- 0: Văn bản
- 1: Ảnh
- 2: Tập tin
5. Cập nhật trạng thái tin nhắn
Đánh dấu một tin nhắn (hoặc nhiều tin nhắn) trong cuộc trò chuyện đang hoạt động với các trạng thái gửi mới.
Yêu cầu
- Phương pháp: ĐẶT
- URL: /api/chat/tin nhắn/trạng thái
- Ủy quyền: Mã thông báo mang
- Tiêu đề: Content-Type: application/json
Thân thể:
(Trạng thái3 đánh dấu ID tin nhắn đã gửi là "Đã đọc")