Help Center Trò chuyện và tin nhắn

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ạiMô tả
trangsố nguyênSố trang. Mặc định: 1
mỗi_trangsố nguyênCác mục trên mỗi trang. Mặc định: 20
tìm kiếmchuỗiTìm kiếm văn bản (ví dụ: tên, số điện thoại)
nguồnsố nguyênEnum nguồn trò chuyện (ví dụ: 1 cho Viber Bot, 2 cho Telegram)
ngàyngà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_idsố nguyênID người dùng Telegram
điện thoạichuỗiSố điện thoại
trạng tháisố nguyên0 = Mới, 1 = Mở, 2 = Đang chờ, 3 = BậtPause, 4 = Đã đóng
Id tổ chứcsố nguyênThu hẹp theo tổ chức
Id toán tửsố nguyênThu 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ể:

{
  "id": 123,
  "status": 1
}

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
  }
]

Tác giả:

  • 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ể:

{
  "status": 3,
  "messageIds": [1, 2, 3]
}

(Trạng thái 3 đánh dấu ID tin nhắn đã gửi là “Đã đọc”)