客服发送图文消息

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.发送图文消息给访客
给当前选中的访客发送图文消息。

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

参数介绍:

属性名 类型 必须 描述
eventId String 否       图文消息的ID,可自定义前缀或者其他格式来通知业务系统图文消息的消息类型:比如:prod-123 ,order-123等
title String 图文消息的标题,如:新款风衣
content String 图文消息的描述,支支持div span style属性,如:产品的价格,优化信息等
imageUrl String 图文消息的图片地址
urlForVisitor String 图文消息提供给访客打开的url,可以为空。
url只允许为http[s]协议,支持新窗口打开以及对话窗口的互动窗口打开。协议格式:http(url,openType)
新窗口打开:http('http://m.echatsoft.com','blank')
互动窗口打开:http('http://m.echatsoft.com','inner')
urlForStaff String 图文消息提供给客服打开的url,可以为空。支持http[s]协议和apiUrl协议。
http协议和urlForVisitor参数中的http协议一致.
apiUrl协议:apiUrl(pageId,openType).
pageId:业务系统的页面ID
openType:打开类型 reload:重载打开 hash:不刷新已有的业务系统页面.
重载打开:apiUrl(123,'reload');
hash打开:apiUrl(123,'hash');
memo String 图文消息的描述,如:产品评价等
visibility int 图文消息的可见范围.
1:访客客服都可见(默认)
2:只有客服可见,访客不可见
customizeMsgType int 此消息的类型,关系到消息响应时长和访客会话条数指标。
1:访客/客服消息
2:系统消息 默认:首次打开对话窗口时携带的图文消息为系统消息

示例:

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);