Appearance
客服端接口概览
客服端接口用于自建客服工作台。客服先登录建立 Session,再读取工作台初始化数据、订阅实时频道,并对会话和消息执行操作。
接入顺序
text
获取登录验证码 → POST /agent/login/check
↓
GET /agent/data/get
↓
订阅 agent-{agent_id} 与 global-{bid}
↓
读取会话消息 → 发送、已读、撤回、转接、结束与置顶接口分组
| 能力 | 常用接口 | 用途 |
|---|---|---|
| 认证与初始化 | /agent/login/check | 建立客服 Session。 |
/agent/data/get | 加载客服资料、会话列表、分组和设置。 | |
| 消息 | /agent/message/get | 读取消息。 |
/agent/message/send | 发送消息。 | |
/agent/message/revoke | 撤回消息。 | |
/agent/message/translate | 翻译消息。 | |
| 阅读状态 | /agent/message/readed | 标记访客消息已读。 |
/agent/message/updateLastReadTime | 更新最后阅读时间。 | |
/agent/message/unreadcount | 维护列表未读数。 | |
| 会话处置 | /agent/chatting/transfer | 转接会话。 |
/agent/chatting/endConversation | 结束会话。 | |
/agent/chatting/delete | 仅在当前客服侧隐藏会话。 | |
| 会话展示 | /agent/chatting/update | 更新接待模式。 |
/agent/chatting/pin | 更新置顶状态。 | |
| 访客资料 | /agent/visitor/get | 读取当前访客状态。 |
/agent/visitor/update | 更新当前访客状态。 |
认证与请求格式
客服接口使用登录 Session。标准浏览器通过 Cookie 保持登录态;自定义客户端也可以把登录响应中的 Session ID 放入 token 请求头或查询参数。
http
GET /agent/data/get
token: <当前客服 Session ID>该 token 不是 Authorization: Bearer 访客 Token。身份、Session 失效、Cookie 和权限边界见客服端认证。
实时与会话状态
初始化完成后订阅当前客服频道 agent-{agent_id},同时订阅商户全局频道 global-{bid}。消息、撤回、转接、结束和访客资料变化通过实时事件同步;HTTP 接口仍是最终数据来源。
客户端应以 mid 合并消息,以 uid 定位会话。转接、结束或隐藏会话后,不应只依赖本地乐观状态,需合并接口响应和对应实时事件;重连后按消息历史补齐。
先完成工作台最小闭环
先完成登录、初始化、会话列表、消息历史、发送消息、实时更新和已读处理,再扩展翻译、转接、置顶与访客资料编辑。