SubizTài liệu API
Agent

API 4.1

Định dạng agent

Hiểu đối tượng agent: định danh, thông tin liên hệ, vai trò và trạng thái.

Agent là một nhân viên trong tài khoản Subiz của bạn. Agent trả lời khách hàng, tham gia hội thoại và phụ trách hội thoại với vai trò assignee. Khách hàng là đối tượng User, không phải agent. Mọi ID và giá trị bên dưới chỉ mang tính minh họa.

Để lấy agent, xem Lấy danh sách agent và Lấy thông tin agent.

Agent

Một số trường của Agent:

{
  "id": "agent_example",
  "account_id": "account_example",
  "type": "agent",
  "state": "active",
  "fullname": "Sam Example",
  "email": "sam@example.com",
  "phone": "+84900000001",
  "avatar_url": "https://example.com/avatars/sam.png",
  "lang": "en",
  "timezone": "Asia/Ho_Chi_Minh",
  "scopes": [
    "supervisor"
  ],
  "invited_by": "agent_owner_example",
  "joined": 1763107200000,
  "modified": 1763193600000
}
Trường Kiểu Mô tả
id string ID agent. Dùng làm assignee khi giao hội thoại, hoặc làm id thành viên khi mời agent.
account_id string Tài khoản mà agent thuộc về.
type string agent cho agent, hoặc bot. Rỗng nghĩa là agent.
state string Trạng thái agent. Xem Trạng thái.
fullname string Tên hiển thị.
email string Địa chỉ email.
phone string Số điện thoại.
avatar_url, avatar_url_128 string Ảnh đại diện, và bản kích thước 128×128.
gender string male hoặc female, nếu đã đặt.
lang string Ngôn ngữ ưa dùng.
timezone string Múi giờ.
scopes array Vai trò cấp tài khoản, như owner hoặc supervisor.
invited_by string ID của agent đã mời agent này.
client_id string Với bot: ID của bot.
extension integer Số máy lẻ, nếu đã đặt.
joined, modified integer Thời điểm agent tham gia tài khoản và thời điểm bản ghi thay đổi gần nhất.

Trường rỗng bị lược bỏ, và đối tượng có nhiều trường hơn ví dụ. account_id là ID của tài khoản; bản thân đối tượng tài khoản dùng id.

Trạng thái

state Ý nghĩa
pending Đã được mời, đang chờ chấp nhận lời mời.
active Đang hoạt động.
inactive Đã bị vô hiệu hóa.
deleted Đã bị xóa khỏi tài khoản.

Khi chọn agent để mời hoặc giao việc, hãy chọn người có type là agent và state là active.

Agent và khách hàng

Agent User
Là ai Nhân viên của bạn Khách hàng của bạn
Tên Trường fullname Thuộc tính fullname
Trong hội thoại Thành viên hoặc assignee Thành viên

Xem Định dạng khách hàng và thuộc tính cho đối tượng khách hàng.