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的方式传送给业务系统页面。

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

参数介绍:

参数名 类型 必须 描述
paramName String 参数名称
subParamName String 字参数名称,比如visitorData参数的二级参数名visitorId。获取规则为paramName的值根据&分割后获取的子参数的值

返回值:
字符串类型的参数值。
例如获取传入的访客ID

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

4.标记对话

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

示例:echatSDK.setVisitorChatSign({"chatSign":1});

参数介绍:

参数名 类型 必须 描述
chatSign int 是否标记: 1 :标记 0 :取消标记