Webhooks

通过 Webhooks 功能将工作台的对话、顾客数据，以回调方式主动同步到你的服务器，你可以基于收到的数据做进一步处理。

主题

当主题对应的事件被触发时，米多客会向 Webhook URL 发送请求

主题名称	触发事件
开始对话	当对话建立时自动发送通知，通知包含对话模型。
结束对话	当对话结束时，系统自动发送通知，通知包含对话模型。
创建客户	创建客户时，系统自动发送通知，通知包含客户模型。
更新客户	客户名片更新时，系统自动发送通知，通知包含更新后的客户模型。
删除客户	删除客户时，系统自动发送通知，通知内容包含客户ID。
客人消息	访客发来消息时，系统自动发送通知，通知包含访客发送的消息模型。
客服消息	客服发送消息时，系统自动发送通知，通知包含客服发送消息模型。

请求

请求中，米多客会在 HTTP Header 中增加signature，timestamp，nonce，企业需要校验该签名，以验证数据安全性。

签名校验流程如下：

• 对secret，timestamp，nonce 进行 SHA1 加密得到 sign_str；
• sign_str 和 HTTP Header 中的 signature的值进行比对。

响应

状态码	描述
200	成功，米多客将订阅的主题成功推送到 Webhook URL。

注意：米多客在对Webhooks中的接口调用多次失败时，则对该功能暂时封停处理。

会话模型

参数	类型	说明
sessionid	int	会话id
visitorid	int	访客id
nickname	string	访客昵称
remark	string	访客备注
avatar	string	头像
sex	int	性别
age	int	年龄
country	string	国家
province	string	省份
city	string	城市
lng	string	语言
tagids	string	粉丝标签
firstvisittime	datetime	初次访问时间
lastvisittime	datetime	上次访问时间
visittimes	int	来访次数
lastchatoid	int	最后接待的操作员id
lastchatgid	int	最后接待客服分组id
owneroid	int	归属客服id
ownergid	int	归属客服分组id
isblack	int	黑名单标识
appid	string	应用接入 appid
openid	string	应用接入 客人身份标识
appname	string	应用名称
createtime	datetime	会话开始时间
accessway	int	会话接入方式/渠道
cptid	string	接待组件id
chatdevice	int	对话设备类型
chatstarttime	datetime	首次对话开始时间
visitpages	int	访客页数
os	string	访客操作系统
resolution	string	浏览器分辨率
screenbitdepth	string	屏幕颜色位数
timezone	string	时区
browser	string	访客浏览器
useragent	string	浏览器标头
ip	string	访客ip
iplocation	string	访客ip定位
ipexplain	string	访客ip说明
pageurl	string	落地页
pagetitle	string	落地页标题
pagerefer	string	来源
searchkey	string	搜索词
chatpage	string	对话来源，对话发起页
chatpagetitle	string	对话来源标题
vcount	int	访客消息数
ocount	int	客服消息数
chatoperatorids	string	参与对话客服id列表
status	int	访问状态
currentoperatorid	int	当前客服id
currentoperatorgid	int	当前接待客服分组id
lastmsg	string	最后消息内容(访客或客服)
lastmsgtime	datetime	最后消息时间(时间戳)

客户模型

参数	类型	说明
id	int	唯一标识
visitorid	string	客人所属访客id
name	string	客户名称
remark	string	备注
sex	int	性别
age	int	年龄
country	string	国家
province	string	省份
city	string	城市
tel	string	固话
phone	string	手机
qq	string	qq
weixin	string	微信
weibo	string	微博
address	string	联系地址
email	string	邮箱

消息模型

参数	类型	说明
visitorid	string	访客id
oid	string	客服id(仅客服发送消息时存在)
sessionid	string	会话id
contenttype	int	内容类别 0：文本； 1：图片； 2：文件； 4：语音； 5：视频
content	string	仅供文本消息使用
url	string	网址，图片、文件、语音、视频通用
thumburl	string	预览图，图片、视频通用
name	string	文件名称（文件消息）
length	string	文件大小（文件消息）
playlength	string	音频播放时长（音频消息）