SubizTài liệu API
Agent

API 4.0

Lấy thông tin agent

Lấy một agent trong tài khoản theo ID agent.

GEThttps://api.subiz.com.vn/4.0/agents/{agid}

Dùng endpoint này để lấy một agent theo ID, ví dụ để hiển thị tên của assignee trong hội thoại.

Đặt ID agent trong đường dẫn. Tài khoản được lấy từ access token. Không có body.

Phản hồi

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

{
  "id": "agent_example",
  "account_id": "account_example",
  "type": "agent",
  "state": "active",
  "fullname": "Sam Example",
  "email": "sam@example.com",
  "avatar_url": "https://example.com/avatars/sam.png",
  "scopes": [
    "supervisor"
  ]
}

Ví dụ này hiển thị một số trường. Xem Định dạng agent để biết mọi trường.

Trường trả về phụ thuộc vào quyền

Nếu agent sở hữu token có quyền xem agent trong tài khoản, phản hồi chứa đầy đủ đối tượng agent.

Nếu không, phản hồi chỉ chứa các trường sau:

{
  "id": "agent_example",
  "account_id": "account_example",
  "fullname": "Sam Example",
  "avatar_url": "https://example.com/avatars/sam.png"
}

Dùng token có quyền xem agent nếu tích hợp của bạn cần state, email hoặc các trường khác.

Nếu không có agent nào có ID này, yêu cầu trả lỗi. Xem Xử lý lỗi.

Đường dẫn khác

GET https://api.subiz.com.vn/4.0/accounts/YOUR_ACCID/agents/YOUR_AGID hoạt động giống hệt.

Yêu cầu HTTP

Thay YOUR_AGID và YOUR_ACCESS_TOKEN bằng giá trị của bạn.

GET https://api.subiz.com.vn/4.0/agents/YOUR_AGID
Authorization: Bearer YOUR_ACCESS_TOKEN