集成指南

把在线客服能力接入你的业务

天蓬客服提供网站挂件嵌入、实时 WebSocket 会话通道与微信扫码登录。以下为当前可用的接入与集成方式,均以线上实际行为为准。

接入方式

三种默认就绪的对话入口,配合统一管理的工作台。

网站挂件

将客服挂件嵌入官网或落地页,访客无需下载 App 即可发起咨询。

微信

微信内扫码或会话发起咨询,消息实时同步到工作台。

H5

移动 H5

移动端 H5 页面嵌入,适配手机浏览器,随时随地接待。

此外,支付宝、抖音、快手、企业微信、App、小红书、闲鱼等渠道可在「管理后台 → 渠道」启用并填写对应开放平台凭证后接入。

网页挂件嵌入

在「工作台 → 渠道 → 网站」获取嵌入方式,将客服入口挂载到你的站点。访客打开页面即可看到浮动客服窗,点击发起实时咨询;坐席在工作台统一接待,会话、访客画像与历史记录一屏可见。

接口鉴权

坐席与管理工作台接口采用令牌鉴权:登录(/api/login 或微信扫码)后,令牌写入 httpOnly Cookie,同时支持在请求头携带 Authorization: Bearer <token>。当前接口面向已登录的坐席与管理员,按账号(租户)隔离数据。

实时通信(WebSocket)

建立长连接后可实时收发会话与状态,适用于自建监控看板、消息提醒等场景。连接端点:

ws(s)://im.brt.sn.cn/ws

握手参数:role(agent / visitor / admin)、tokenconversationIdvisitorIdchannel;服务端每 30 秒心跳保活。事件如下:

事件方向说明
ready服务端 → 客户端连接就绪,返回角色与上下文
presence服务端 → 客户端坐席在线状态变更(含技能、状态)
conversation_list服务端 → 客户端会话列表下发(按账号隔离)
conversation_update服务端 → 客户端会话创建 / 状态变更 / 指派
message双向新消息到达(访客 / 坐席 / 机器人 / 系统)
typing双向输入态指示
history服务端 → 客户端历史消息(访客侧)
audit服务端 → 客户端审计日志实时推送(管理员)
error服务端 → 客户端鉴权或参数错误提示

客户端可上行:message(发消息)、typing(输入态)、assign(指派,坐席)、close(结束,坐席)。

微信扫码登录

采用微信开放平台「网站应用」OAuth2 授权码流程:访客 / 坐席扫码 → 微信授权 → 回调 /api/wechat/callback → 按 openid 查找或自动注册账号;未绑定手机号时引导短信验证码绑定。

支付结果回调

套餐升级的微信支付 / 支付宝订单,由对应平台通过 /api/payment/wechat/notify/api/payment/alipay/notify 将支付结果推送给系统(被动接收第三方回调),校验后订单与权益实时生效。沙箱环境可演示完整下单与回调流程。

当前能力边界

本系统暂未对外开放「AppId / AppSecret 开放平台」、Webhook 主动推送与官方多语言 SDK;上述能力在后续版本规划中。如需对接自有系统,可基于本页所述的网页挂件嵌入、WebSocket 通道与微信登录进行集成。集成细节以线上 im.brt.sn.cn 实际行为与源码为准。

继续探索

查看功能手册、产品全貌或更新动态。