SubizTài liệu API
Hội thoại và tin nhắn

API 4.0

Lấy thông tin hội thoại

Đọc trạng thái, thành viên, người phụ trách và kênh của hội thoại.

GEThttps://api.subiz.com.vn/4.0/conversations/{cid}

Dùng endpoint này để kiểm tra một hội thoại trước khi thao tác: ai tham gia, ai phụ trách và hội thoại diễn ra trên kênh nào.

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. Subiz đọc hội thoại trong tài khoản của access token.

Tham số Kiểu Mô tả
cid (đường dẫn) string ID hội thoại.

Phản hồi

Yêu cầu thành công trả HTTP 200 cùng một đối tượng Conversation. Một số trường:

{
  "id": "conversation_example",
  "account_id": "account_example",
  "created": 1763107200000,
  "state": "active",
  "assignee": "agent_example",
  "members": [
    {
      "id": "user_example",
      "type": "user",
      "membership": "active"
    },
    {
      "id": "agent_example",
      "type": "agent",
      "conversation_id": "conversation_example",
      "membership": "active"
    }
  ],
  "touchpoint": {
    "channel": "facebook",
    "source": "page_example",
    "id": "profile_example"
  }
}
Trường Mô tả
id ID hội thoại.
state Trạng thái hiện tại, như active hoặc ended.
assignee Agent phụ trách hội thoại. Bị lược bỏ khi chưa giao.
members Người tham gia. Mỗi người có type (user cho khách hàng, agent cho agent), id và trạng thái membership.
touchpoint Kênh mà hội thoại diễn ra.
created, ended Dấu thời gian Unix tính bằng mili giây. ended bị lược bỏ khi hội thoại còn mở.
last_message_sent Sự kiện tin nhắn không nội bộ gần nhất, nếu có.

Trường rỗng bị lược bỏ. Đối tượng có nhiều trường hơn ví dụ; bỏ qua những trường tích hợp của bạn không dùng.

Bước tiếp theo

Là thành viên và là assignee là hai việc riêng. Agent có thể phụ trách hội thoại mà không nằm trong members.

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.

GET https://api.subiz.com.vn/4.0/conversations/YOUR_CID
Authorization: Bearer YOUR_ACCESS_TOKEN