插件接口
点密客服提供开放的 API 接口，允许您将客服功能集成到自己的系统或工作流中。
一、API 概述
1.1 接入方式
- 所有接口通过 HTTPS 协议访问
- 使用 API Key 进行身份认证
- 数据格式为 JSON
1.2 获取 API Key
- 登录管理后台
- 进入「全局设置」>「其他设置」
- 在租户信息中查看或生成 API Key（App 密钥）
安全提示：请妥善保管 API Key，不要在客户端代码中暴露。如果怀疑 Key 已泄露，请立即重新生成。
二、Web 渠道嵌入 API
2.1 基础嵌入代码
将以下代码添加到网站 HTML 的 </body> 标签之前：
<script>
(function(w, d, s, u) {
// 嵌入代码
})(window, document, 'script', 'YOUR_CHANNEL_URL');
</script>
2.2 传递访客信息
通过 API 可以在页面加载时传递访客信息：
// 设置访客信息
window.dmChat = window.dmChat || [];
window.dmChat.push(['setUser', {
name: '访客名称',
email: '[email protected]',
phone: '13800138000',
// 自定义字段
customFields: {
company: '公司名称',
level: 'VIP'
}
}]);
2.3 API 方法
| 方法 | 说明 |
|---|---|
open() |
打开聊天窗口 |
close() |
关闭聊天窗口 |
setUser(info) |
设置访客信息 |
on(event, callback) |
监听事件 |
三、常见集成场景
3.1 与 CRM 系统集成
通过 API 将客服对话中的客户信息同步到您的 CRM 系统：
- 访客进线时自动查询 CRM 中的客户资料
- 对话结束后将沟通记录回写到 CRM
3.2 与工单系统集成
- 将无法即时解决的问题转为工单
- 工单状态变更时通知座席和访客
3.3 与电商系统集成
- 访客浏览商品时自动展示商品信息
- 在对话中发送订单卡片和物流信息
四、注意事项
- API 调用有频率限制，请合理控制调用频率
- 敏感操作（如删除数据）建议增加二次确认
- 建议在测试环境验证接口调用后再上线生产环境
- 保持 API Key 的安全性，定期轮换
