一洽客服系统访客端API-HTTP接口

1.使用场景

在APP渠道访客端无法调用echat.js提供的接口时可使用此文档中提供的http接口在APP端直接发起请求,来满足部分业务解决方案的实现,为避免无效访问,建议此文当中的所有接口都在APP内打开过咨询窗口时进行调用,没有打开过咨询窗口的访客不会产生一洽客服系统的业务数据。

2.获取访客未读消息条数

在访客打开APP后可通过此接口获取已知身份访客的客服未读消息条数,通过渲染角标和其他提示引导用户读取。

接口地址:

标准版接口地址:

https://eapi.echatsoft.com/getVisitorUnReadMsgCount
https://eapi.echatsoft.com/getVisitorUnReadMsgCount/1.0 (仅返回unreadMsgCount字段)
https://eapi.echatsoft.com/getVisitorUnReadMsgCount/1.1 (三个字段都返回)

多商户版本接口地址:

https://papi.echatsoft.com/getVisitorUnReadMsgCount

示例:

 https://eapi.echatsoft.com/getVisitorUnReadMsgCount?visitorId=webvipwbq191&metaData=rOiZ%2f3oqM5v77klDHOCzEiBoKkIz4rXPXE4wkxXIZm%2bKmZWit2N0xUuZMILJunQNj7HFSOwSKT3Ts0laR%2f0BEvyZQahIA7n9tXljgqjjNHRmI%2fyDuUEMP6uYoEbnJOPVt2P9pvVDdIKhPl21tvVJbNjZtNDk3ZLnNbp5jwCqxR8433qIQLcKSiHCg4ObKK44k29RmiCWX6kGzraU%2fLvzWCADYACXrSLWiAu0QfuLQEMPorAKG6%2fv1FwsxPt5TzJCG6YbAptozD%2fRTeqrjVu6iwFmCTjbrSxIjY7VIug6IDNXf1x2gRGsIJ8zb0yJDpUuu7eyQOz96N%2bUrrsAh0SwPt57zTNtIfdflws0freNgjFblJ%2biwp%2fXzLcF2hMmw7rlZnlvosJug11Dsi3JyaR7i7d%2f%2bjX%2bhA6n7omNZp9n6tvWo2vd5%2fTWRW6Jv9sHMG8dj43HcXPZoF6ooZOw4sNWWtiw3mymQ8XmEuxiO9HIgLvyhKhuuFdh4ySH5cIpe%2fcFYuIRsA4XevS35TsNNFGZ%2ffZ%2bor%2fxTtUyvODITyHW%2fiyp%2b1T8brDL1Qr%2bBwKfyXVmQBtmubuIrs6hjJCxRSzJUtoaTFv5okYLNkNHQ3NEmGVoIe8mRLpjVq3h2zWNf0ztQpAE4lRp6Qdpolop00P9p%2bTNRW0sGSfL0Vrw4GRuVS1HZSbjlKV%2f6rlvjUBao6QAAJnQPKIDhpDzCml7zaWrWg6TBFEFuCStHn%2f%2bL0U755852l8f6keoBM8babbgMTPC3ldE1afJPVMb%2bZ0Z7nizia8Qor8gcozFnTnIy6lIxhPMxXZ2%2f2WmIVhMnbT8WcTCxh%2f5F%2bkA%2bnBp9TWZyGTi030eTmARTbCKOO25%2bLg2CjJLnGSM4cH4mf2VNj4fqmUIJCsImAnMUvhOVcUVeiyYxzV3YhzDz47Q6f87LIBLMbS%2b6RCMUhs6CjjsUgAT35S2xISnlzeAXH00ppc%2bYRYXZDXEUEw6ip7MNCjtpmYY5tpceFh9QxXI1bbCJX3MPVmjm9jNFGBCFZ5%2fX3vskwJ5Gnq6wIej%2bEApfK43gj5w3NQ%3d&companyId=500029

访问限制

参数 是否必须 说明
companyId 企业账号的公司ID
metaData 会员访客的身份信息,接入方式见:业务系统集成文档 metaData 参数和 visitorId-encryptVId 必选一组。
visitorId 匿名访客的访客ID,例如 web123 sdk456。可通过js-app交互接口在打开对话窗口后获取
encryptVId 匿名访客的加密访客ID,用来验证接口请求的合法性。可通过js-app交互接口在打开对话窗口后获取
platformSign 多商户版本的账号,如果要获取某个访客在某个商户的未读消息数量则需要追加平台签名,防止企业的商户信息被遍历。

支持请求方式:

get&&post

数据返回:

json

正确返回示例:

{"unreadMsgCount":0}
或者: {"lastMsgContent":"你好","tm":1574651635573,"unreadMsgCount":2}

错误返回示例:

{"errcode":110,"errmsg":"metaData解析错误"}

返回字段解释:

字段 类型 解释
unreadMsgCount int 访客的未读消息数量
lastMsgContent string 访客语企业沟通的最后一条消息内容,可以是访客消息也可以是客服消息
tm long 返回此消息时的时间戳,可根据此参数忽略掉迟来的远程推送通知

3.访客发送图文消息给客服

在访客打开会话窗口后可通过此接口发送图文消息给客服,例如跳转至订单页面发送订单图文给客服。

标准版接口地址:

https://eapi.echatsoft.com/pushVisitorEvent

多商户版本接口地址:

https://papi.echatsoft.com/pushVisitorEvent

示例:

https://eapi.echatsoft.com/pushVisitorEvent?visitorId=webvipwbq191&metaData=rOiZ%2f3oqM5v77klDHOCzEiBoKkIz4rXPXE4wkxXIZm%2bKmZWit2N0xUuZMILJunQNj7HFSOwSKT3Ts0laR%2f0BEvyZQahIA7n9tXljgqjjNHRmI%2fyDuUEMP6uYoEbnJOPVt2P9pvVDdIKhPl21tvVJbNjZtNDk3ZLnNbp5jwCqxR8433qIQLcKSiHCg4ObKK44k29RmiCWX6kGzraU%2fLvzWCADYACXrSLWiAu0QfuLQEMPorAKG6%2fv1FwsxPt5TzJCG6YbAptozD%2fRTeqrjVu6iwFmCTjbrSxIjY7VIug6IDNXf1x2gRGsIJ8zb0yJDpUuu7eyQOz96N%2bUrrsAh0SwPt57zTNtIfdflws0freNgjFblJ%2biwp%2fXzLcF2hMmw7rlZnlvosJug11Dsi3JyaR7i7d%2f%2bjX%2bhA6n7omNZp9n6tvWo2vd5%2fTWRW6Jv9sHMG8dj43HcXPZoF6ooZOw4sNWWtiw3mymQ8XmEuxiO9HIgLvyhKhuuFdh4ySH5cIpe%2fcFYuIRsA4XevS35TsNNFGZ%2ffZ%2bor%2fxTtUyvODITyHW%2fiyp%2b1T8brDL1Qr%2bBwKfyXVmQBtmubuIrs6hjJCxRSzJUtoaTFv5okYLNkNHQ3NEmGVoIe8mRLpjVq3h2zWNf0ztQpAE4lRp6Qdpolop00P9p%2bTNRW0sGSfL0Vrw4GRuVS1HZSbjlKV%2f6rlvjUBao6QAAJnQPKIDhpDzCml7zaWrWg6TBFEFuCStHn%2f%2bL0U755852l8f6keoBM8babbgMTPC3ldE1afJPVMb%2bZ0Z7nizia8Qor8gcozFnTnIy6lIxhPMxXZ2%2f2WmIVhMnbT8WcTCxh%2f5F%2bkA%2bnBp9TWZyGTi030eTmARTbCKOO25%2bLg2CjJLnGSM4cH4mf2VNj4fqmUIJCsImAnMUvhOVcUVeiyYxzV3YhzDz47Q6f87LIBLMbS%2b6RCMUhs6CjjsUgAT35S2xISnlzeAXH00ppc%2bYRYXZDXEUEw6ip7MNCjtpmYY5tpceFh9QxXI1bbCJX3MPVmjm9jNFGBCFZ5%2fX3vskwJ5Gnq6wIej%2bEApfK43gj5w3NQ%3d&companyId=500029

访问限制

最大访问频率无限制,最大访问次数限制:24小时内最多调用500000次,如需调高访问次数联系企业专属客服申请。

get参数

参数 是否必须 说明
companyId 企业账号的公司ID
metaData 会员访客的身份信息,接入方式见:业务系统集成文档 metaData 参数和 visitorId-encryptVId 必选一组。
visitorId 匿名访客的访客ID,例如 web123 sdk456。可通过js-app交互接口在打开对话窗口后获取
encryptVId 匿名访客的加密访客ID,用来验证接口请求的合法性。可通过js-app交互接口在打开对话窗口后获取
platformSign 多商户版本的账号,如果要给某个商户的客服发送图文消息则需要此签名,防止企业的消息被遍历

post内容

post图文消息的json对象,组装方式见图文消息的详细定义

示例:

{
"eventId": "cook1004",
"title": "莱斯够2017春韩版新套头显瘦宽松V领两件套毛衣",
"content": "<div style='color:#666;line-height:20px'>原价:<span style='text-decoration:line-through'>¥186.50</span></div><div style='color:#666;line-height:20px'>促销:<span style='color:red'>¥143.75</span></div><div style='color:#666;line-height:20px'>运费:<span style='color:#ccc'>卖家承担运费</span></div>",
"imageUrl": "http://demo.echatsoft.com/vmini/mycookie/images/1.jpg",
"urlForStaff": "apiUrl(263,'reload')",
"memo": "评价(199)"
}

支持请求方式:

post

数据返回:

json

正确返回示例:

{"unreadMsgCount":0}

错误返回示例:

{"errcode":110,"errmsg":"metaData解析错误"}

4.返回码定义

详见一洽客服系统对外接口全局返回码定义