入门
特色功能
免费私有化部署 👈
配置文件修改说明
部署新服务器 👈
Windows 服务器
Linux 服务器
宝塔面板(aaPanel)
Docker
Linux 服务器
使用域名
使用 IP 地址
宝塔面板
使用域名
使用 IP 地址
Windows Docker Desktop
发布客服端程序
升级现有服务器
Windows 服务器
Linux 服务器
宝塔面板
服务器维护
Windows 服务器
Linux 服务器
宝塔面板
开通自动翻译服务
配置文件存储
公告
免费在线使用(快速上手指引)
详细使用说明书(功能介绍) 📔
准备使用客服端软件
2020年5月之前的 Win10 / Win7
站点管理
客服账号管理
基础会话功能
辅助会话功能
个性化站点配置
访客管理
访客留言
集成及二次开发
对接及二次开发
Open Api 开放接口
向客服系统推送消息
您可以调用客服系统接口,实现消息推送。
官方环境的消息推送地址:https://kf-api.shengxunwei.com/OpenApi
,私有化部署时,将主程序域名换成您自己的域名即可。
注意:使用 POST 方式,设置
ContentType = "application/json"
调用接口时,在 HTTP 请求头 Headers 中,添加:siteCode
:站点代码secretKey
:调用密钥,在 Web 管理后台的站点设置中切换至 Open Api 画面维护。
PushDialogMessage
向访客推送聊天消息https://kf-api.shengxunwei.com/OpenApi/PushDialogMessage
推送普通文本消息
{
"customerId": "4226a1cb-953e-480a-8954-6343e8f56315",
"externalId": null,
"staffNickName":"自动助手",
"content": "下单成功。",
"type":0
}
customerId
:访客在客服系统中的 Id。externalId
:集成客服系统时,由业务系统传过来的访客 Id。
这 2 个参数任选其一即可,如果都传,那只有 externalId 起作用。
推送扩展消息
如果希望推送图片或者文件,可将 type
指定为 2,然后在 content
中按以下格式放入 json 字符串,注意转义。
注意: content 字段中存放的是 json 字符串,不是 json 对象。
推送图片消息:{"type":"image","url":"https://name.com/image.jpg"}
完整示例:
{
"customerId": "4226a1cb-953e-480a-8954-6343e8f56315",
"externalId": "",
"staffNickName":"自动助手",
"content": "{\"type\":\"image\",\"url\":\"https://name.com/image.jpg\"}",
"type":2
}
推送文件消息:{"type":"file","name":"文件名","size":0.69,"url":"https://name.com/file.zip"}
完整示例:
{
"customerId": "4226a1cb-953e-480a-8954-6343e8f56315",
"externalId": "",
"staffNickName":"自动助手",
"content": "{\"type\":\"file\",\"name\":\"文件名\",\"size\":0.69,\"url\":\"https://name.com/file.zip\"}",
"type":2
}
目录
入门
特色功能
免费私有化部署 👈
配置文件修改说明
部署新服务器 👈
Windows 服务器
Linux 服务器
宝塔面板(aaPanel)
Docker
Linux 服务器
使用域名
使用 IP 地址
宝塔面板
使用域名
使用 IP 地址
Windows Docker Desktop
发布客服端程序
升级现有服务器
Windows 服务器
Linux 服务器
宝塔面板
服务器维护
Windows 服务器
Linux 服务器
宝塔面板
开通自动翻译服务
配置文件存储
公告
免费在线使用(快速上手指引)
详细使用说明书(功能介绍) 📔
准备使用客服端软件
2020年5月之前的 Win10 / Win7
站点管理
客服账号管理
基础会话功能
辅助会话功能
个性化站点配置
访客管理
访客留言
集成及二次开发
对接及二次开发
Open Api 开放接口