Appearance
开发接入
按你拿到的东西判断在对接哪种渠道,再进对应的开发文档。命令与事件两种渠道通用。
先确认你在对接哪种渠道
合从的接入渠道分两种,装法和能用的能力不完全一样。你手上拿到的东西就能判断:
| 你拿到的是 | 那就是 | 从这里开始 |
|---|---|---|
一段 <script> 接入代码 | 网页接入渠道 | 接入代码与配置项 |
一个链接,或一个要你部署的 chat.html | 对话链接渠道 | 对话链接概述 |
| 都没拿到,只知道要「对接客服」 | 先去问是哪种渠道 |
接入代码长这样:<script src="...hecong.js" data-channel-id="...">;链接长这样:https://.../?c=...。都没拿到的话,去工作台 设置 > 渠道管理 看渠道类型,或问建渠道的同事。
两种渠道交给你的命令和事件是同一套,形状完全一致,业务代码基本可以照搬。要注意三处差别:
- 拿到命令对象的入口名不同 —— 网页接入是
window.hecong(cb),对话链接是window.hecongLink(cb) - 网页接入能程序化开关聊天窗,对话链接是整页聊天,没有窗口可开关
- 对话链接能通过网址参数带入客户资料,网页接入没有这条路;而对话链接要写 JS 则必须用自有域名部署,官方域名的链接你没有地方写代码
网页接入渠道
装在你自己的网站上,访客点聊天按钮咨询。
| 能力 | 说明 |
|---|---|
| 接入代码与配置项 | script 标签、两个可配属性、就绪回调 |
| 传客户资料给客服 | 客户 ID 的取值要求、字段上限、失败处理 |
| 打开与关闭聊天窗 | 用页面上自己的按钮触发咨询 |
| 切换聊天窗的界面语言 | 多语言站点跟随站点语言 |
| 商品、订单与文章选择器 | 访客把正在看的商品直接发给客服 |
| 指定由哪个技能组接待 | 你的系统算好归属,接待直接进对应的组 |
| 监听聊天窗事件 | 埋点统计、联动你自己的业务逻辑 |
| React 与 Vue 接入示例 | 框架项目的完整写法 |
| 接口速查 | 全部命令、事件与类型定义 |
| 接入问题排查 | 按报错现象查原因 |
对话链接渠道
一个链接点开就是聊天页,发给客户、印成二维码、嵌进小程序都行。
| 能力 | 说明 |
|---|---|
| 接入形态选型 | 用官方域名还是自己的域名,责任边界在哪 |
| 自有域名部署 | 下载 chat.html 放到自己的服务器上 |
| 传客户资料给客服 | 网址参数与页面内调用两种做法 |
| 商品、订单与文章选择器 | 客户把要问的那一件发给客服 |
| 监听聊天页事件 | 埋点统计、联动你自己的业务逻辑 |
| 接口速查 | 全部命令、事件与类型定义 |
| 区分投放来源 | 一条链接投多处,用 utm 参数分辨来源 |
| 指定由哪个技能组接待 | 链接挂参数或用代码指定,各门店进各自的组 |
| 嵌入小程序 | 微信、支付宝、抖音三个平台的配置差异 |
不分渠道的能力
这两类跟你用哪种渠道无关。
| 能力 | 说明 |
|---|---|
| 在工作台右栏嵌入自有页面 | 客服接待时直接看到你系统里的订单、工单 |
| 让 AI 调你的接口 | 机器人查订单、查物流、建工单 |
| 接入 MCP 服务 | 用 MCP 协议把已有工具接给机器人 |
这些做不到
以下能力当前不提供,做方案前先核对:
| 你可能想做 | 现状 |
|---|---|
| 用代码替客户发一条消息 | 做不到 |
| 预填输入框里的文字 | 做不到 |
| 服务器之间对接(调接口或收推送) | 都不提供 |
| 指定分给具体某一位客服 | 做不到 |
几点补充:命令面里没有发消息的方法,选择器是客户自己点选后发出的,不能程序化替他发;合从当前只有跑在客户浏览器里的这套前端能力;分配可以指定由哪个技能组接待,但不能点名到人。
两种渠道可以同时用,同一个客户在两边传同一个 id,会归到同一份客户档案。
npm 包与渠道编号
合从不提供 npm 包
npm registry 上没有任何 @hecong/* 包,任何 npm install @hecong/xxx 的写法都是错的。两种渠道都通过 script 标签接入,React、Vue 项目也一样。
文档里所有示例的渠道编号都是占位值,需要换成你自己的。它在工作台 设置 > 渠道管理 > 选择渠道 > 安装代码 里,复制出来的代码已经填好了。