2.1 回调型接口
初始化前调用: 紧跟在V5的嵌入代码后调用。
默认情况下,插件会在js加载完成后自动进行初始化,所以需要在初始化前调用的接口一般都紧跟在V5的嵌入代码后方。
2.1.1 插件加载完成的回调
如果你想修改插件上面按钮的样式和位置等参数,在插件加载完成回调中即可进行相应操作。
单按钮型插件包装在一个id为
v5btn
的div
内,多按钮的插件包装在一个id为'v5bar'的ul
或者div
内。
V5CHAT('onPluginLoad', function() {
// Your code here
});
2.1.2 对话窗口加载完毕的回调
如果你选择的插件样式包含页内的对话框,则在对话框加载完毕后会触发此回调。
例如,如果需要页面加载后立即自动显示对话框,这时候可以进行显示对话框接口
V5CHAT('showChat')
的操作,不过,此功能可直接在V5后台【系统接入】-【插件配置】里选择【会话框】-【自动弹出】,建议使用后台配置方法即可。
V5CHAT('onReady', function() {
// Your code here
});
2.1.3 会话连接建立的回调
V5客服系统的设计是在客户有所操作(发消息,点击对话按钮,转人工按钮等)之后才建立会话连接,这样避免大量无效客户进入客服服务需求,会话连接建立后,就可以调用发送消息的接口了,如 V5CHAT('msg', '我刚刚查看了某某商品')
。
V5CHAT('onConnect', function() {
// Your code here
});
2.1.4 收到消息的回调
收到客服或者机器人的回复之后触发此回调,回调函数带一个参数,为消息的文本内容。
可以在此回调中触发显示页面内自定义的消息提醒。
V5CHAT('onMessage', function(text) {
// Your code here
});
2.1.5 服务状态的回调
可以在此回调中得知客户服务状态,进行所需的自定义处理。
V5CHAT('onStatusChange', function(status) {
// Your code here
});
status
参数表示服务状态,客户服务状态分为:
0
: 机器人服务中1
: 等待人工的排队中,此时仍然由机器人自动回复2
: 人工客服服务中3
: 人工客服服务中,但开启了托管,由机器人自动回复
2.1.6 对话框显示的回调
如果你选择的插件样式包含页内的对话框,则在对话框从隐藏到显示时会触发此回调。
V5CHAT('onChatShow', function() {
// Your code here
});
2.1.7 对话框隐藏的回调
如果你选择的插件样式包含页内的对话框,则在对话框从显示到隐藏时会触发此回调。
V5CHAT('onChatHide', function() {
// Your code here
});
2.1.8 销毁插件后的回调
如果你认为页面内某个使用场景之后不再需要V5智能客服插件了,可调用接口 V5CHAT('destroy')
来销毁插件,随后会触发此回调。
V5CHAT('onDestroy', function() {
// Your code here
});