6500

一洽客服系统客服端JS-SDK API

目录

1. 概述
2. JS-SDK接入步骤
3. 获取页面参数
4. 监听选中的访客（暂未开放）
5. 发送图文消息给访客
6. 发送文本消息给访客(未开放)
7. 发送图片消息给访客(未开放)
8. 发送视频消息给访客(未开放)
9. 发送语音消息给访客(未开放)
10. 发送文件消息给访客(未开放)
11. 标记会话业务状态
12. 监听访客消息(未开放)
13. 监听访客信息更新(未开放)

1.概述

一洽客服端JS-SDK是向一洽企业客户提供的基于业务系统和客服工作台通信能力为基础的网页开发工具包。

通过此JS-SDK企业开发者可在一洽提供的客服功能之上提供更加符合企业业务的功能和能力。开发者可借助此API实现向访客发送消息，监控访客消息，监听crm更新等一洽客服工作台的业务功能。比如通过业务系统向正在聊天的访客发送企业自有faq系统中的问句答案，通过集成商品列表的业务系统向正在聊天的访客已图文消息的形式推荐产品。

2.JS-SDK接入步骤

步骤一：引入js
在需要调用sdk接口的业务系统页面引入如下js

https://es.echatsoft.com/open/staff/jssdk-1.0.0.js

步骤二：通过config接口注入权限验证配置
所有需要调用SDK接口的页面必须经过一洽的身份验证后，一洽客服工作台才会接受业务系统向客服端发送的指令。

echatSDK.config({
    debug: true, // 开启调试模式,所有业务系统调用的sdk接口都会在控制台打印出来，包括调用的方法以及参数。
    timestamp: , // 必填，生成签名的时间戳
    nonce: '', // 必填，生成签名的随机串
    signature: ''// 必填，签名
});

签名算法见:签名算法介绍

步骤三：通过ready接口处理成功验证
只有在验证成功后在可以正常使用SDK提供的接口功能。

echatSDK.ready(function(){
    // config信息验证成功后会执行ready方法，所有接口调用都必须在config接口获得结果之后
});

步骤四：通过error接口处理失败验证

echatSDK.error(function(res){
    // config信息验证失败会执行error函数，如签名过期导致验证失败，具体验证失败信息通过res查看。
});

3.获取页面参数

通过此方法获取业务系统页面打开时测参数属性值。业务系统打开时一洽会根据客户的配置将业务系统所需的数据通过get的方式传送给业务系统页面。
get参数的传送和具体信息详见：业务系统接入文档

调用方法：echatSDK.getParamData(paramName,subParamName);

参数介绍：

返回值:
字符串类型的参数值。

例如获取传入的访客ID

var visitorId = echatSDK.getParamData("visitorData","visitorId");

4.监听选中的访客（暂未开放）

通过次访客接接收到一洽工作台中客服在对话、留言、监控、访客列表位置实时选中的访客ID。此ID和当前工作台中客户信息栏显示的访客ID保持一致。

调用方法：echatSDK.onSelectVisitor(callback);

注：使用此方法时业务系统不应该接收任何实时的参数，否则访客切换时当前业务系统页面也会被reload，那么此回调也就不会产生

参数介绍：

回调方法传参为Json对象。

5.发送图文消息给访客

给当前选中的访客发送图文消息。

调用方法：echatSDK.pushVisitorEvent(visEvt);

参数介绍：

示例:

var visEvt = {"eventId":"cook1005","title":"2016秋冬新品复古欧式感大花苞袖宽松毛衣","content":"<div style='color:#666;line-height:20px'>原价：<span style='text-decoration:line-through'>¥414.99</span></div><div style='color:#666;line-height:20px'>促销：<span style='color:red'>¥211.64</span></div><div style='color:#666;line-height:20px'>运费：<span style='color:#ccc'>卖家承担运费</span></div>","imageUrl":"http://demo.echatsoft.com/vmini/mycookie/images/0.jpg","url":"apiUrl(263,'reload')","memo":"评价（299）"};

ecahtSDK.pushVisitorEvent(visEvt);

效果:

6.发送文本消息给访客(未开放)

给当前选中的访客发送文本消息。

调用方法：echatSDK.sendTxtMsgToVisitor(content);

参数介绍：

7.发送图片消息给访客(未开放)

给当前选中的访客发送文本消息。

调用方法：echatSDK.sendImageToVisitor(imageInfo);

参数介绍：

8.发送视频消息给访客(未开放)

给当前选中的访客发送文本消息。

调用方法：echatSDK.sendVideoToVisitor(videoInfo);

参数介绍：

9.发送语音消息给访客(未开放)

给当前选中的访客发送文本消息。

调用方法：echatSDK.sendVoiceToVisitor(voiceInfo);

参数介绍：

10.发送文件消息给访客(未开放)

给当前选中的访客发送文本消息。

调用方法：echatSDK.sendFileToVisitor(fileInfo);

参数介绍：

11.标记会话业务状态

给当前选中的会话设置企业的业务状态，如当前业务系统并非关联的会话，那么此方法调用失效。

调用方法：echatSDK.setVisitorChatSign(chatSign);

参数介绍：chatSign为json对象

示例:

var chatSign = {"chatSign":1};
echatSDK.setVisitorChatSign(chatSign);

12.监听访客消息(未开放)

访客发送消息给客服时触发此监听。

调用方法：echatSDK.onReceiveMsg(callback);

参数介绍：

回调函数接收参数为json

13.监听访客信息更新(未开放)

访客的crm信息被客服更新时触发此监听。回调函数会收到客服本次更新的客服信息。

注:只有当前登录客服更新某个访客的客户信息时才会触发回调。

调用方法：echatSDK.onCrmUpdate(callback);

参数介绍：

回调函数接收参数为json