SaleSmartly聊天插件JSSDK开发者文档

一、简介

在插入代码后(ssq为全局变量),可以通过以下方法进行信息修改和聊天窗口调用。

二、API

2.1 设置登录信息

可以在用户登录后,设置用户信息,对应的在客服系统就可以看到设置好的信息。

ssq.push('setLoginInfo', {
  user_id: 'b58e64cfxs2ym', // 必填,加密后的用户 id
  user_name: 'test_yy', // 必填,用户名
  language: 'ru-RU', // 插件语言
  phone: '+861592014xxxx', // 手机(注意!带上手机区号)
  email: 'test@test', // 邮箱
  description: '套餐B\n客户端\n收费客户', // 描述
});

2.2 清理用户登录信息

可以手动清理用户登录信息,用于PWA站点中,退出登录后,没有刷新页面时执行。

ssq.push('clearUser'); 

2.3 打开聊天窗口

可以手动用程序打开聊天窗口,用于某些特殊场景下可以引导用户咨询客服,比如支付失败。

ssq.push('chatOpen'); 

2.4 关闭聊天窗口

可以手动用程序关闭聊天窗口。

ssq.push('chatClose'); 

2.5 监听未读信息

监听未读消息,用于自定义消息通知。

ssq.push('onUnRead', function(obj) {
    console.log(obj.num); // 未读数量
    console.log(obj.list); // 未读内容
});

2.6 隐藏图标

可以结合“监听未读信息”和“打开聊天窗口”的方式,实现自定义图标

window.__ssc.setting = { hideIcon: true}; 

2.7 监听发送信息

监听访客发送信息,然后进行数据统计或上报,可用于广告效果统计或归因。

ssq.push('onSendMessage', function(obj) {
    console.log(obj);
});

2.8 监听接收信息

监听访客接收信息,然后进行数据统计或上报,可用于广告效果统计或归因。

ssq.push('onReceiveMessage', function(obj) {
    console.log(obj);
});

2.9 监听窗口打开

监听窗口打开,然后进行数据统计或上报,可用于广告效果统计或归因。

ssq.push('onOpenChat', function() {
    // 上报数据
});

2.10 监听窗口关闭

监听窗口关闭,可以上报数据进行分析。

ssq.push('onCloseChat', function() {
    // 执行其他事件
});

2.11 监听打开信息收集

监听打开信息收集(聊前调查和离线留资),可以上报数据进行分析。

ssq.push('onOpenCollection', function() {
    // 执行其他事件
});

2.12 监听完成信息收集

监听完成信息收集(聊前调查和离线留资),可以上报数据进行分析。

ssq.push('onCollectionInfo', function() {
    // 执行其他事件
});

2.13 监听插件图标点击事件

监听插件图标点击事件(打开),可以上报数据进行分析。

// 监听点击line
ssq.push('onOpenLine', (obj) => {
  // 执行其他事件
});
// 监听点击messenger
ssq.push('onOpenMessenger', (obj) => {
  // 执行其他事件
});
// 监听点击Email
ssq.push('onOpenEmail', (obj) => {
  // 执行其他事件
});
// 监听点击telegram
ssq.push('onOpenTelegram', (obj) => {
  // 执行其他事件
});
// 监听点击Whatsapp
ssq.push('onOpenWhatsapp', (obj) => {
  // 执行其他事件
});