客伴客服接入开发文档

聊天接入开发文档

先看懂接入方式,再登录工作台复制你自己的窗口代码。网站用悬浮窗,App 和桌面软件用独立聊天链接,三种方式最终都回到同一个客服工作台。

支持文字、图片、视频和 60 秒语音不需要调用内部 APIHTTPS 才能使用语音

你的产品是什么,就按哪张卡接入

01

网站、商城、落地页

在页面中加载一次悬浮窗脚本。它会负责入口、未读数、声音提醒和聊天面板。

查看网站示例
02

Android / iPhone App

用系统 WebView 打开独立聊天地址,保留 DOM Storage,并按系统流程申请麦克风权限。

查看 App 要求
03

Windows / macOS 软件

使用 WebView2、WKWebView、Electron、Qt 或 CEF 加载同一个独立聊天地址。

查看桌面软件要求

复制代码,放到页面底部

登录工作台进入“网站接入”,复制当前窗口生成的完整代码。下面是结构示例,不能直接替代你账号里的窗口密钥。

  1. 先设置域名权限把实际网站域名加入“域名权限”,测试域名和正式域名分别填写。
  2. 脚本只加载一次放在网站根布局或 </body> 前,Vue、React 路由切换时不要重复创建。
  3. 发送一条真实消息测试用无痕窗口发送文字、图片、视频和语音,再回到客服工作台确认都能播放。
website.html示例
<script
  src="https://你的客服域名/widget.js"
  data-key="你的窗口密钥"
  defer></script>

窗口密钥只从登录后的“网站接入”页面复制,不要写进公开文档或提交到代码仓库。

让 WebView 像一个正常页面

App 不需要拼接内部接口,也不需要保存管理员 Cookie。加载登录后生成的独立聊天链接即可。

必须打开JavaScript、DOM Storage、HTTPS、文件选择
按需申请用户点击语音后,再申请 RECORD_AUDIO 或麦克风权限
不要清除不要每次打开都清 Cookie、缓存和 localStorage,否则会产生新访客

固定数据目录,限制页面跳转

Windows 使用 WebView2,macOS 使用 WKWebView;Electron、Qt 和 CEF 按同样的规则处理。

Windows开启 JavaScript、DOM Storage 和文件选择,处理 PermissionRequested 麦克风请求。
macOS保留 WKWebsiteDataStore.default(),实现文件选择和 WKNavigationDelegate 导航白名单。
共同要求使用可写的持久化数据目录,不忽略 HTTPS 证书错误,不允许页面跳到任意外部网站。

五分钟确认接入没有遗漏

01正式域名已加入白名单02无痕窗口能发送文字03图片和视频能预览04语音能录制和播放05客服回复能实时收到
接入遇到问题时,请提供操作系统、浏览器或 WebView 版本、发生时间和脱敏后的错误信息。不要提交窗口密钥、访客令牌、管理员 Cookie 或服务器密码。