一洽客服系统-实时接收会话业务数据

目录

1. 选择数据接收模式
2. 消息加解密说明
3. 选择接收的业务数据
3.1.登录状态
3.1.1.公司状态变更
3.1.2.分组状态变更
3.1.3.客服状态变更
3.1.4.路由状态变更
3.1.5.留言分配信息
3.2.对话数据
3.2.1.对话开始
3.2.2.对话结束
3.2.3.对话接通
3.2.4.对话转接
3.2.5.对话内容
3.2.6.对话评估
3.2.7.对话满意度评价
3.3.客户数据
3.4.浏览数据
3.4.1.访客进入
3.4.1.1.关键字数据
3.4.2.访客离开
3.4.3.轨迹数据
4. demo代码下载

1.选择数据接收模式

安全模式:POST给消息接收接口的数据会进行加密,消息接收方需要对其进行解密后才能使用,数据安全性较高
明文模式:PSOT给消息接口的数据是明文的XML数据,数据安全性较低,如果不想解密业务消息,请尽量使用SSL协议的接口地址。

接口调用方式:POST
接口GET参数:签名信息(每次调用一洽都会讲签名信息以GET参数的形式追加在接口地址中)

注意:每次收到post请求后需要返回一洽 success 没有返回一洽会判断为未收到而重新发送

2. 消息加解密说明

什么是EncodingAESKey?
一洽采用AES对称加密算法对消息体对行加密,EncodingAESKey则是加密所用的秘钥。消息接收方用此秘钥对收到的密文消息体进行解密。

消息加解密过程和微信公众平台的消息加解密方式一致。
示例代码(包括C++、php、Java、Python和C#版本)示例代码
注:一洽的签名信息在GET请求中,微信的示例代码签名在XML结构中,Encrypt节点的加解密方式是一样的。

Java要求jdk 1.6及1.6以上
异常java.security.InvalidKeyException:illegal Key Size的解决方案:在官方网站下载JCE无限制权限策略文件(请到官网下载对应的版本, 例如JDK7的下载地址:http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html 下载后解压,可以看到local_policy.jar和US_export_policy.jar以及readme.txt,如果安装了JRE,将两个jar文件放到%JRE_HOME%\lib\security目录下覆盖原来的文件;如果安装了JDK,将两个jar文件放到%JDK_HOME%\jre\lib\security目录下覆盖原来文件

3.选择接收的业务数据

一洽服务器会根据开发者选择的数据模块POST相应的业务数据给开发者服务器URL,主要数据包括:
登录状态 、对话数据 、客户数据 ,以下是每种数据类型业务数据的详细数据和介绍

3.1登录状态
在线和离线解释:

状态 解释
在线 当前有客服登录状态为在线或者忙碌,可正常接入对话
离线 当前没有客服登录或者所有登录客服的状态为离开或者隐身,请求进入留言处理

3.1.1 公司状态变更
GET参数追加:dataType=companyStatus
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=companyStatus

描述:公司中有客服在线和全部客服离线时下发该数据
POST内容:公司当前状态XML信息
明文XML示例:

<xml>
    <msgId>39086491</msgId>
    <tm>1563852820059</tm>  
    <companyStatus>1</companyStatus>
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[YrU6kXHIBgy03Vq9QbJU54cwPSxyJlgeJJV8/xCDlsFPONdHhoJzINJqVI5Wo6yVJMjaOaf5Xt1Wup3UQo5/lDnRM3y5hnxGcI82f7aQ0wRcm4HQVvHmwqP+9+lnBbLL]]></Encrypt>
</xml>

companyStatus状态解释

状态 含义
msgId 该条消息的唯一id
tm 时间戳
companyStatus 1:在线 2离线

3.1.2分组状态变更
GET参数追加:dataType=skillStatus
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=skillStatus

描述:当分组中有客服在线和全部离线时下发该数据
POST内容:分组状态XML信息
明文XML示例:

<xml>
    <msgId>39086491</msgId>
    <tm>1563852820059</tm>  
    <skillStatus>1</skillStatus>
    <skillId>3</skillId>
    <skillNanme><![CDATA[订单组]]></skillName>
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[4dEBoMVBC4OstAFSGJ4YcrsrbiHq6T3Ot5uQh3wdYq7X/Rd/CC5LHAtN2K9y/Gz1ibnNzWZoO0E2W24k5C0zvGHNnS1K/4uWDht0/IaoJhgA0IBpLDr/OXWVx+SWReEtnL2ehmeL9Fxt81z724aPPxuIkKEIdZBP79W5mI+u+5pcAmch2VbOEH0APkYbJu/XZAhoGxKYPfNOnIFigRzb3w==]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
skillId 状态发生变化的分组ID
skillNanme 状态发生变化的分组名称
skillStatus 当前分组的状态 1:在线 2:离线

3.1.3 客服状态变更
GET参数追加:dataType=staffStatus
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=staffStatus

客服状态改变时,下发该数据
POST内容:路由状态XML信息
明文XML示例:

<xml>
    <msgId>39086491</msgId>
    <tm>1563852820059</tm>     
    <staffStatus>2</staffStatus>
    <staffId>1556</staffId>
    <staffLogname><![CDATA[18948777432]]></staffLogname>
    <staffName><![CDATA[胡仲舜]]></staffName>    
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[37vOG3cQ5KKSlb+O5+PTZwHOrAQRB0v57bdh9CArghPmk27vaVH7/9U117aRXrOVyweluFqRI43Baq41H8HgpzjFoyoy45nTW2pxk/ZJbP/pWG1Pwk3hSwtvQaD97haGf2cs7QVZA3mV6E8Z8Chw/1MolA7OQxCXwU8/3bi/SxzDIoeTKS+4gwGbUUvfwSo/8JPKCk37X+T73/bhufoe0rdNgX8PkFG7+83KiUpgupPZq8Ehp7Kr+TbA7Pmiq8og]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
staffId 状态发生变化的客服ID
staffLogname 状态发生变化的客服账号(手机/邮箱)
staffName 状态发生变化的客服姓名
staffStatus 当前客服的状态 1:在线 2:忙碌 3:离开 4:隐身 5:退出

3.1.4 路由状态变更
GET参数追加:dataType=routeStatus
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=staffStatus

客该路由下客服分组中的客服在线或者全部离线时(溢出分组)下发该数据
POST内容:路由状态XML信息
明文XML示例:

<xml>
    <msgId>39086491</msgId>
    <tm>1563852820059</tm>     
    <routeStatus>2</routeStatus>
    <routeId>3533</routeId>
    <routeName><![CDATA[在线客服]]></routeName>    
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[37vOG3cQ5KKSlb+O5+PTZwHOrAQRB0v57bdh9CArghPmk27vaVH7/9U117aRXrOVyweluFqRI43Baq41H8HgpzjFoyoy45nTW2pxk/ZJbP/pWG1Pwk3hSwtvQaD97haGf2cs7QVZA3mV6E8Z8Chw/1MolA7OQxCXwU8/3bi/SxzDIoeTKS+4gwGbUUvfwSo/8JPKCk37X+T73/bhufoe0rdNgX8PkFG7+83KiUpgupPZq8Ehp7Kr+TbA7Pmiq8og]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
routeStatus 指定路由的状态 1:在线 2:离线
routeId 状态发生变化的路由ID
routeName 状态发生变化的路由名称

3.1.5 留言分配信息
GET参数追加:dataType=leaveMsgOwner
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=leaveMsgOwner	

留言分配时触发此消息下发包括系统自动分配和客服手动分配 以及客服认领。
POST内容:路由状态XML信息
明文XML示例:

<xml>
    <msgId>39086491</msgId>
    <tm>1563852820059</tm>     
    <visitorId>web377724523</visitorId>
    <chatRecordId>2_5987809</chatRecordId>
    <staffId><![CDATA[4442]]></staffId>
    <staffLogname><![CDATA[[allen@echatsoft.com]]></staffLogname>    
    <staffName><![CDATA[刘虹山]]></staffName> 
    <ownerData>   
    <ownerId>4443</ownerId>
    <ownerLogname>yangtong@echatsoft.com</ownerLogname>     
    <ownerName>杨通</ownerName>
    </ownerData>     
    <chatDepartmentId>123</chatDepartmentId>
    <chatDepartmentName><![CDATA[售前]]></chatDepartmentName>
    </xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[37vOG3cQ5KKSlb+O5+PTZwHOrAQRB0v57bdh9CArghPmk27vaVH7/9U117aRXrOVyweluFqRI43Baq41H8HgpzjFoyoy45nTW2pxk/ZJbP/pWG1Pwk3hSwtvQaD97haGf2cs7QVZA3mV6E8Z8Chw/1MolA7OQxCXwU8/3bi/SxzDIoeTKS+4gwGbUUvfwSo/8JPKCk37X+T73/bhufoe0rdNgX8PkFG7+83KiUpgupPZq8Ehp7Kr+TbA7Pmiq8og]]></Encrypt>
   </xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
visitorId 会员的唯一值
chatRecordId 对话记录ID 唯一值 例如1_5201314
staffId 手动分配者客服id(等于 -1 是系统自动分配)
staffLogname 手动分配者客服账号(手机/邮箱)
staffName 手动分配者客服姓名
ownerId 所有者的ID
ownerLogname 所有者登录的用户名
ownerName 所有者姓名
chatDepartmentId 本次分配对话的分组ID,如果是全部人员接待则ID为0
chatDepartmentName 本地分配对话的分组名称 例如:订单组 。如果是全部人员接待则 不下发该字段数据

3.2 对话数据

访客开始建立对话到对话结束,一洽会向数据接收方推送6种数据:对话开始、对话结束、对话内容、留言内容、对话主题评估、满意度评价

3.2.1对话开始

GET参数追加:dataType=chatStart 或者 robotChatStart
chatStart:人工对话/留言开始
robotChatStart:机器人对话开始
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=chatStart

POST内容:对话开始的XML信息
明文XML示例:

<xml>
    <msgId><![CDATA[39113876]]></msgId>
    <tm><![CDATA[1563864422482]]></tm>
    <chatStatus><![CDATA[1]]></chatStatus>
    <myData><![CDATA[network=wifi&game=斗地主&ver=9.2&os=ios10]]></myData> 
    <metaData>
    <uid><![CDATA[1314521]]></uid>
    <grade><![CDATA[1]]></grade>
    <category><![CDATA[金牌会员]]></category>
    <name><![CDATA[王宝强]]></name>
    <nickName><![CDATA[宝宝]]></nickName>
    <gender><![CDATA[男]]></gender>
    <age><![CDATA[36]]></age>
    <birthday><![CDATA[2015-08-01]]></birthday>
    <maritalStatus><![CDATA[2]]></maritalStatus>
    <phone><![CDATA[18990987546]]></phone>
    <qq><![CDATA[9876389]]></qq>
    <wechat><![CDATA[echatsoft]]></wechat>
    <email><![CDATA[9876389@qq.com]]></email>
    <nation><![CDATA[中国]]></nation>
    <province><![CDATA[广东]]></province>
    <city><![CDATA[深圳]]></city>
    <address><![CDATA[深南大道金融街]]></address>
    <photo><![CDATA[http: // www.baidu.com/mypic.png]]></photo>
    <memo><![CDATA[娱乐明星]]></memo>
    </metaData> 
    <visitorData> 
    <visitorEnterTime> <![CDATA[2020-04-09 10:59:43]]> </visitorEnterTime> 
    <visitorMedia><![CDATA[5]]></visitorMedia>
    <visitorType><![CDATA[4]]></visitorType>
    <visitorId><![CDATA[wechato6ohSwjIVENM7ZbBqPypRyu4D_zA]]></visitorId>
    <visitorName><![CDATA[王宝强]]></visitorName>
    <visitorPhoto><![CDATA[http:// wx.qlogo.cn/mmopen/WncXm]]></visitorPhoto>
    <visitTimes><![CDATA[5]]></visitTimes>
    <visitorLan><![CDATA[zh_CN]]></visitorLan>
    <visitorIp><![CDATA[122.96.185.139]]></visitorIp>
    <visitorCountry><![CDATA[中国]]></visitorCountry>
    <visitorProvince><![CDATA[广东]]></visitorProvince>
    <visitorCity><![CDATA[深圳]]></visitorCity>
    <browserName><![CDATA[QQ浏览器]]></browserName>
    <browserVersion><![CDATA[9.0]]></browserVersion>
    <screenResolution><![CDATA[1920*1080]></screenResolution>
    <osName><![CDATA[Windows]]></osName>
    <osVersion><![CDATA[7]]></osVersion>
    <se><![CDATA[baidu]]></se>
    <keyword><![CDATA[在线客服软件]]></keyword>
    <keywordType><![CDATA[]]></keywordType>
    <referPage><![CDATA[http://www.baidu.com/baidu.php?sc.WwCK00j7A0GeyEPIcgU]]></referPage>
    <firstTime><![CDATA[2016-01-09 17:53:32]]></firstTime>
    <firstPage><![CDATA[http://wx.qlogo.cn/mmopen]]></firstPage>
    <firstPageTitle><![CDATA[一洽软件的价格]]></firstPageTitle>
    <lastChatTime><![CDATA[2015-07-08 11:23:36]]></lastChatTime>
    <lastChatStaffId><![CDATA[14]]></lastChatStaffId>
    <lastChatStaffLogname><![CDATA[218098933897]]></lastChatStaffLogname>
    <lastChatStaffName><![CDATA[郑丽文]></lastChatStaffName>
    </visitorData> 
    <routeData> 
    <routeId><![CDATA[72]]></routeId>
    <routeName><![CDATA[一洽]]></routeName>
    <styleId><![CDATA[201]></styleId>
    <styleName><![CDATA[一洽网站]]></styleName>
    <chatDepartmentId><![CDATA[11]]></chatDepartmentId>
    <chatDepartmentName><![CDATA[订单组]]></chatDepartmentName>
    </routeData> 
    <chatData>
    <chatPage><![CDATA[http://wx.qlogo.cn/mmopen]]></chatPage>
    <chatPageTitle><![CDATA[一洽软件的价格]]></chatPageTitle>
    <chatTimes><![CDATA[5]]></chatTimes>
    <chatEvent><![CDATA[1]]></chatEvent>
    <chatRequestTime><![CDATA[2016-01-09 17:54:32]]></chatRequestTime>
    <chatAnswerTime><![CDATA[2016-01-09 17:54:58]]></chatAnswerTime>
    <chatType><![CDATA[1]]></chatType>
    <chatStaffId><![CDATA[14]]></chatStaffId>
    <chatStaffLogname><![CDATA[18098933897]]></chatStaffLogname>
    <chatStaffName><![CDATA[郑丽文]]></chatStaffName>
    <chatStaffRole><![CDATA[超级管理员]]></chatStaffRole>
    <chatEntrance><![CDATA[售后]]></chatEntrance> 
    <chatRecordId><![CDATA[1_5987809]]></chatRecordId> 
    </chatData>
</xml>	

密文XML示例:

<xml>
    <Encrypt><![CDATA[XEki0sFhQHZnnlWcz8Gz8ZrBez3ZxBXYq+qhycqvBNtNLIWud+GLMQO0ZInmuJMYPjAA2MtAv8h4INyzsqemM3uo9hUq8zqX9GPpWwDZTpu3WDU4QDoYCx52v2H5ghYmqb6L6m49zaxI1BBYxuj9J3RKDltum5gYWnYHLKq4CXARTVb/lus1kfGzEbGZyB35JPtHqXz05BrYLg3SFwgcXbOLpSm8Q6b6rFfiOfeKdYPbUb48dhBLifG0lxSoZ2NBlIVotwvlIVlqEnPhpcN0d2wg2I83RzwCn9K4ohuUkGcQ4/mLHvSUmhI8TW/W9gkas3UWuQ214ZFjKsvq4cEuPDcH+UTNR5EiYipX5eOjabb1Pz7Zun3zDiX5HJTYXkrKkdE9qe/pl//OHlZCi1Kpqz91essRGb1IK+F4oCMeP9cPQji+tQ7C7MfkxUmTDR+wiOjVHbniGJ/gbWra8d6a/LDNCK3HKqPzFc7r8kCHs7ZdURWNbxc/NSyqyyNN2xuT/mxTpM59BuODa4dH0ReqWm3OiXN7onQN0yCD5qWDEn9l31QtmGU7KjJsP7AEmTaRc874kNd4xFrEaiXoI5AiigPYmd3BjrMEIPg3nXlcP7xEjVMLxlRF+WUs+72g+OyaCC8o05oCq6AZ6Zrn6fY1/3QAqvlH+pAPjenjgWY3/x22w26SU8+LWmvhVLYsn+3JFlRvPlASoa8OYru1KZfdP9/d61HVytmOiYHF7iMSmV0f9M5l4B0ld4aeHqUMTZ+3wceRH6WzFPWpzUAMweEa/cq0QAlpTsW0Zd8I39z1YK4XFh2A0sQfMB5UTmzJsn8MSW4rsrP6g72BlYqQGzp19F6r4WID4NLFZ8/wpw+7AdrW02e6r7rSuFNPstagpB95tjHlb114ajjgONkN6Z6maURllOWHGa1eDWqjvNECT/Qgj7KFv1AheevCvVL1lIRKF95tLYCe6gDGeD4aEzRrzF+T0qur6e/jNewBb9vePidEU6eGGesrc/RhCpz122Uu1J5002yO1/mfjhzSX4/nKJCH7mHYxC7UlOAfbLzDWzuMLnMrlvZ0pxEjdWvrti9hhF1JJNfhtcin/P8aEc9aZlMQBrT0BGGKwqHYsAgW/m33cx7wdjVwywKupDVj8m6QYXub8LSE+BpNjTNLdhajedJNQaCdAnOzbkeoifFstfhLpvetBtigkKeDTnIe2k2FaPp1Ompg9/nm2C92FM8/UB6jYDj3PJQPsnWu/HYK4sx2Vn2P/A2EzjJmKmuqoZm3eu5cZBeUI0m3gPqQ0jdQmfKFH7Mn8jYZgrhgYGe+bdIuXctsGmxO01SVMlFpzlmADmQ7tGf0wVtsg4y64ofmQ0CrfeSOqKxc9UHQ5S0n5d/1nPWz4ZaUcTMgNsckP/A+H/2lmkDdAaZ0Pw584FzIEcfXssbBioy54YHBM/An9zsLUwVLqjIoMHyHRw2OK/evQYAZFhfp758c+kHX702QUcbBuxxyNVBmonYu+NjRzLyck2Cqwd7p0pKXzspYHI8yD95ao4qdMZngnnsKVjim9zFYIurA5vwv64nPukBM1WbFnAuDuMFSx/1qLhxz8YVZjDMiY35KEoVmhWGv6AzN0i2IB3lxz1EKDbZxWJ1pkiy9drFu2aSZFntd98rQhPt7zG4RbT+yhzhyUgXrIkhtI4LVgfHc/lil7bNtkhuYutZzJmuS0cJOVN2oChWPBhXPYs0tVlJ+PcSocT2W7ttcTrcqfnB8IKYG0xDLmi5yJW5xkDkrRNvfbEH9a1VkJeRVFGNXTMSn+lChQXBYox0ccJ2bjUMeMh2Zrze8ygn1EDL6ehzh0tOb4b2SKOKj35Te7BtjHaGn1Ly6PfcsKcL0MNaGDZH01vs5L715PNMbDrUVQvoDFjxp4Eyov3yPpM9fDpVUuafAROiwp3gF1NqH0lwxu5ISznghK4SVUPmDDnv+Ss6X8LBnoupturOJpzY5crQEUqD5JRjLXf31mfI0tG4SL84FTDzCLWzJ0j8j0G4AQENhB77ISrHwvffGLuoOqoOHRaalpZcBGVHtQm4TVJ3foBKnvbXdMcw/uU4G2AXqa/fJ/kcUUyqbg/FDVTDJPJNAC3XWJNQWmPmq4mg9cwt4vPYsSZFqrLBUUr2DMA1RPu5sKuvtOeFm7jUqpDYtHwcc8txBKnsW6hJeLlCs1FF1XfOaxVI4Eb58NtfvTB6j4/rVuBK3sRQniAiYD2KQbvcWQ8sw2tABOBbAB3Saqw9y9E6RkoZ23yuaoZyeVjzSwxanlRU6v+WtzK4SUMjl/G+RM557BDWfaL8jpjpGG01Uwj9AYeNGz5hzvekAw8QL9BYG4oujBhiysUxBMqk75gz0rw6QaMpiPa3G/IvSWf067d5Ly3vzrummu84xBlOaRsglvilMKcpxNurPImOCi5/QQphkRGRe6Nd+1vfmfhmGbmHhO48zIKHazhz6EpOcCdByydTvC9va0VDreom+1hLASoenUxNp0gaNsFWwHt13qKY7V72tAJvZzJUbyQTab0JLqeuT7ZRlmbBJ7aaiwDRbLDrVdGaU5Y7J6SKOW1vAdTtSscjCxvTRVT1mTCWjl7VJy2E7yvJ4BhxE1UL744rUqeAH8Y7hToHpSo6Qjdv1awJxhh6thlQ6onQLRzmxbZRFoxw5r/ySY9NdWLmXkWxuqU8A40PSCdHFsk4PS2vaL+LfhFLiM4l+c4PXhkuBf8rOqIG++7c5sZvU345IXjHmCclvrSXoQFzQVyimqGe8Z6KSLTRSZO5z6x2YIDl0uG5q75cl2RWheRfUEPllI++5pO86thHYHZAoDxi6Tr2xnwXYXV+KvxJK9skvb1MljOZmGkONsDAK7XMAp8IPc38yCvX5CU5ab0G1nuKdLQmnJzLFb+lLJS6q9olYaWMF9CGfa7C6HJFtmnN3Epbw6kusRy3aPixz8SSKO30wYZfdQ4eWm952G7IbVoBLZSDTA1/hVfJHx4BM2V+h285cMoe0cSeqQXxD5UY26ekI7ptde3pw49NEzEl1BU3cnKATzL6ONnAjVnilaCWySU85tYJhthvfEaN5VJFNu17t0ZTk4lGDaTRdVcJ9lsQIsnJy6xq9jKLKkTmXWptTwb/UzS73wxT8/Tu2lIx4RlWeeXKZdRs+pQOamCSa0WBWyXtEaB4DXjI3tDRyMWRGWWDhCsrt+IIYSBzcAEmvCzT/iybLJeUnZ44akzGwTAM2AgeKlGjjc8DVqnE+V5uemM4avb+n0wgyKMDF/96SVGNZEqWJOzYd100nZ//OXQvV+1U3xFbfpIHkkiIg3AY9VXQ7q9EPc7K32cyV+/R5adZbfpWgHY6z3Inod0CZse0u0d712F+VetGNWZGOmq+2p6t5N9BmKnqYvhk/jT8i5XviZv9TIHhEW5kbSZKQzHCUqoxTfnPVw+LOFJFQNwQlQ3ASC0VqJnoN+7fcWyOTCY8au0WFgu19ZV/OjWkIrttV4eu8VsC+NcJmoGBX6z4A5XVt9+2qdF+khSGwwiD97sIANfJ52QOETfnCTq38VtYLS9bEvBpuOrICVMqmELyLC8A/NSWKe10R79wM4kKsK7gSBfrZCWM6yZe29K0bAi+ISn/2AkkrhNx2WVFmRFANRouaIt6PmrMqXPe5Wg3t8f5z8TcYTejQFjR2Cxwlou+7OqeBiUapVIpmTG3KQr4I8EDSJGZ4ZVtUTRhsDAAl2gsGj5qM8zrcxjXuCcTiQXk9z/MimHzg+WC3gudZQ8kiOe2duFZqOyhPo0/G9ovblm2vIBar0hHzPYGFwOAXUHYpiCkC0YDfINgBTxPDv3NskXQCWnXJDtJWECEMIvGHWevlHiEXS0qCSEA7iB2BYP1qAdWgYlyx95Zbjm3eLPIYW/B5bvAuJyFB0Xxw5efeA7+9L2/DIL45/jWKKjvrFjKrRvDD3xf5BzjmhXBs62a9cyr6q0huKRnLiJvaXuf9cyePQYnGPiCor8/NPK5NwiEiJs+/6ib50EsxCVqHA0o+5ZpZx8xQi1R/62fAi/eZ8P7TWAcuwBomLNgPIh+sKnsMmCJyyJOkxgFzj0xDQ7JVjt8MJWu1MydKwW1OUlBBQ64Q/tmxSG8MWHEOBrdCZngbMFKYyOfTU3+VVYnyTS4oxeU3aqu/yeZLHGlkCPBl1RImKGROL2+mTKYnXxXyBnnr2jzH0/s911IyzkkwaQ1asVTJYBuyFVLfb3UYQk5j3GuTr15D6rzHdtKtnq4GqxaSniz7utIudTYTKvPe5wfQMr8vhMYBQcHIjv8gTG3gy7MweEnj4LD6xIvvZByPpaahw03VmN/E8ygR+WeqUOzevnrJGFU2z9CO/lSf0o6OzfyCPnLYfMnHoqOXP0NMujAKTBS7QC59kk8a/I9umkn4DnutGhgMXQbZDvl9nATZkt6MJfND0+XkjkHSY9GbcjTvde5tKQ9o9ZX7cXG2TXzL5zRl]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
chatStatus 1:人工对话开始 2:人工对话结束 3:留言开始 4:留言结束 5:机器人对话开始 6:机器人对话结束
myData 开发者自定义扩展数据,如果打开对话时加了这个参数则传递该数据

metaData(会员数据,如果是会员则传递该数据)

属性 含义
uid 会员的唯一值
grade 会员级别,大于0的数字
category 会员类别 例如:金牌会员
name 会员姓名 例如:王宝强
nickName 会员的昵称 例如:宝宝
gender 会员的性别,0-未知, 1-男, 2-女
age 会员的年龄
birthday 会员的生日 例如:2015-08-01
maritalStatus 婚姻状况 1:未婚 2:已婚 0:未知
phone 会员的联系电话
qq 会员的QQ
wechat 会员的微信
email 会员的邮件地址
nation 会员的国家
province 会员的身份
city 会员的城市
address 会员地址
photo 会员头像地址
memo 会员备注信息

visitorData(访客数据)

属性 含义
visitorEnterTime 访客进入的时间
visitorMedia 客户端的媒介,1-PC网页,2-手机网页,5-微信,6-sdk,200-自定义渠道
visitorType 访客身份类型 -1未知,0-游客(web),1-会员(vip),2-SDK游客(sdk),4-微信(wechat),5-自定义接口(custom)
mediaId visitorType==5时,此值有效,值为自定义渠道的渠道ID
visitorId 访客ID,身份描述+ID
visitorName 访客的姓名 例如:王宝强
visitorPhoto 访客的头像 例如:http://wx.qlogo.cn/mmopen/WncXm
visitTimes 访客来访的次数
visitorLan 访问者的语言 例如:zh,en
visitorIp 访客的来访IP
visitorCountry 访客所在国家 例如:中国
visitorProvince 访客所在省份 例如:广东省
visitorCity 访客所在城市 例如:深圳市
browserName 访客的浏览器 比如:qq   微信对话无此属性
browserVersion 访客的浏览器版本 比如:9.0   微信对话无此属性
screenResolution 访客的屏幕分辨率 例如:1920*1080   微信对话无此属性
osName 访客操作系统 例如:Windows   微信对话无此属性
osVersion 操作系统版本   微信对话无此属性
se 访客来访的搜索引擎 例如:baidu   微信对话无此属性
keyword 访客来访的搜索关键字 例如:一洽软件   微信对话无此属性
keywordType 0:未区分SEO、推广 1:自然优化 2: 推广
referPage 访客来源的URL,如果是微信,就是公众号名 例如:http: // www.baidu.com/baidu.php?sc.WwCK00j7A0GeyEPIcgU
firstTime 进入网站的时间 例如:2016-01-09 17:53:32   微信对话无此属性
firstPage 落地页 例如:http://www.echatsoft.com   微信对话无此属性
firstPageTitle 落地页面的标题 例如:一洽软件  微信对话无此属性
lastChatStaffId 上次对话的客服ID
lastChatStaffLogname 上次对话的客服账号
lastChatStaffName 上次对话的客服姓名

routeData(本次对话的路由数据)

属性 含义
routeId 接入对话的路由ID -1:web访客的默认路由 -2:微信对话的默认路由 -3:SDK对话的默认路由
routeName 路由名称
styleId 路由所使用的样式ID
styleName 路由所使用样式的名称
chatDepartmentId 本次分配对话的分组ID,如果是全部人员可接待则ID为0
chatDepartmentName 本地分配对话的分组名称 例如:订单组

chatData(对话数据)

属性 含义
chatPage 对话页面 例如:http://www.echatsoft.com   微信对话无此属性
chatPageTitle 对话页面标题 例如:一洽软件   微信对话无此属性
chatTimes 访客的对话次数
chatEvent 对话发起的方式,1-点击图标,2-接受邀请对话,3-客服主动对话,4-微信输入任意文字接入对话,5-微信点击菜单接入,6-微信输入指定文字接入,7-微信机器人转人工,11-机器人转人工,12-机器人转留言,14-web自动弹屏自动接入,15-web自动弹屏访客输入消息接入,16-商户留言转平台接入,17-微信开发者接入,18-自定义渠道事件接入,19-自定义渠道发送消息接入
chatRequestTime 请求对话的时间 例如:2016-01-09 17:54:32
chatAnswerTime 对话接通的时间 例如:2016-01-09 17:54:32
chatType 会话类型 1-在线对话,2-忙碌对话,3-离线消息,5-机器人对话
chatStaffId 接待对话的客服ID 人工对话有效
chatStaffLogname 接待对话的客服登录名 人工对话有效
chatStaffName 接待对话的客服姓名 人工对话有效
chatStaffRole 接待对话的客服的内部角色名称 例如:客 服主管 人工对话有效
chatEntrance 对话入口 访客端传参为echatTag的值
chatRecordId 对话记录的ID,唯一值 例如:1_123321

3.2.2对话结束
GET参数追加:dataType=chatEnd 或者 robotChatEnd
chatEnd:人工对话/留言结束
robotChatEnd:机器人对话结束
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=chatEnd

POST内容:对话结束的XML信息
明文XML示例:

<chatStatus><![CDATA[2]]></chatStatus>
<chatData>
<chatRecordId><![CDATA[5987809]]></chatRecordId>
<chatEndTime><![CDATA[2016-01-09 17:54:58]]></chatEndTime>
<chatEndType><![CDATA[客服关闭]]></chatEndType>
<chatTotalTime><![CDATA[8200]]></chatTotalTime>
<chatWaitTime><![CDATA[16]]></chatWaitTime>
<firstAnswerTime><![CDATA[2]]></firstAnswerTime> 
<avgAnswerTime><![CDATA[5]]></avgAnswerTime>
<visitorSendMsg><![CDATA[25]]></visitorSendMsg>
<staffSendMsg><![CDATA[35]]></staffSendMsg>
<perfectMatchs><![CDATA[1]]</perfectMatchs>
<exactMatchs><![CDATA[1]]</exactMatchs>
<similarityMatchs><![CDATA[1]]</similarityMatchs>
<misMatchCount><![CDATA[1]]</misMatchCount>
<solvedCount><![CDATA[1]]</solvedCount>
<unsolvedCount><![CDATA[1]]</unsolvedCount>
<activelyInviteEvaluating><![CDATA[1]]</activelyInviteEvaluating>
</chatData>
<staffKpis>
<staffKpi>
<staffId><![CDATA[14]]></staffId>
<staffLogname><![CDATA[13128888888]]></staffLogname>
<staffName><![CDATA[一洽客服]]></staffName>
<firstAnswerTime><![CDATA[2]]></firstAnswerTime> 
<avgAnswerTime><![CDATA[5]]></avgAnswerTime>
<visitorSendMsg><![CDATA[25]]></visitorSendMsg>
<staffSendMsg><![CDATA[35]]></staffSendMsg>
<duration><![CDATA[35]]></duration>
</staffKpi>
<staffKpi>
<staffId><![CDATA[15]]></staffId>
<staffLogname><![CDATA[13128888666]]></staffLogname>
<staffName><![CDATA[一洽客服]]></staffName>
<firstAnswerTime><![CDATA[2]]></firstAnswerTime> 
<avgAnswerTime><![CDATA[5]]></avgAnswerTime>
<visitorSendMsg><![CDATA[25]]></visitorSendMsg>
<staffSendMsg><![CDATA[35]]></staffSendMsg>
<duration><![CDATA[35]]></duration>
</staffKpi>
</staffKpis>
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[gUHc0D73LA5oHk+mfxqebcitJQGnoIUjYfSt2OzBIhoGQ3WU8RP0hVDFusA2CJN+wpZl4Wn/0wwjrK9+Nq4bP5+J8D1iSr610av5rvBrWPqV+ukvQYKR13msx7h/xDCBRu6txKQvgXVcTMiYZgj93mP/zWm9DU8ltWr8cZPwP1Xta692Qz1CSjInxuh2QC0dtVuL+3/abqvG7ZB6ZYhruvfQOD4VxHe6QfyBYWszgn+ptxB6drMWn8IHzed0L9MbCZcpk7jLv1pltsnpYJIcPfOrA5Tu9/gqfdj1HbjXkbrht8dWuKUTv+J+qavZVhH7epOwzJS5BMJuW55vntHHoQmNIKo5Okygy5UDL/mE2NLjaA3zKjVdL3TZdEip4FKAiRQORS964Th4TT3bz6SApg8XtCc6jsnhQ7vB5/kzkPJn55rHma+1ScOoJVJeYgyipOXqLK2I+qwbBeCIYkiaVkdDiUeu29w7s94Tqf7mL9LspnMRqTvadAsXanbdnFWeMDRhYk+iLUPfYs1lzH7uZg+Hzxbpw2fOzOjuZegK1mCCJyaW0jxY6JiFcUVc7pHYGLh28dsj09Fk4JQ30K6wuXwbOf8sJRbXCOeg4ta2xgZk011G0jTF4AtT7MVkbwVfaYtX5s2pUHqriqYpmCOqQbpQl1c31Y8FU2Ee7oFKEoZx2Az5e/sHECvExhYwywCi5cBEY+a6skfOAqxjoYM29HXyMkHWoVx8IVu2lT03N9DE2t1oXBVx6xpehHs1/x2cAAu+LpgXy/7ORxD6MnY6hYfRcbEnE1d5xQP14+6Q2pRLn3EhCvVqSfwK4Vpv/U+/DOW0AeVytf2qM+g3HG7ljof+YxahjFQpMa0Z//SCNlXqjQsJ+Z3TtraBijxNkIN1VVPYCErJyfQw3PTL20frPOENj2gCwIkX2NefTUoAozQg92gkwKXGAdgvWcPVnmE/9h4Qg7snaoxOiRkCd3jp9iJjfKtqJr4i+2GHRtUJ0l8a2lmKDtQI1+2mQx1F0NotM7vXLKo24DiaQJsR2qr5cs2HTl1hVPV6/sAX0fc12sRfurcOCgOcusEk4F2KzsNGeUWM0DAQCWTLYLelAIs1Mnciz0M/G2fGEV9Utgbjcd2gO/8p4vdt5gTERUIbNNKNAWbaY6ZK+HXqdtcCXgi9Z8jXXCCfBz+DtmCdToNOBgG8XJ2/XhhCBSpVemf0TCSUkmPvAP1po130JO/JP1P0gDxMiIIfn/VbCqOqHaXIRf725UtK1tZ5M9mD12wDP2mzt14WpXiwHC45XZCzzQPPt828YceTQYsLU0N+B3xM9xM1EzgQj1uYo41Rdn7C8pVJfvcPCy2WDyJAg6CNgJ6pY1EbT7nB4p4z3UcCMA73BjTkgzoBX3KMHdln3I8bz8bHucGda4omev1w60ZFbmgoZIcvBSnU35td/waAtdah2pQaIs33lRRQ14/hY9JY3900yJKuGYvTKjpNvJCl7Fx8dnjp+OxhcfAlfCnzKj1P8Nvj+hypzjULU188nby8t07v59avszMEM3yqhBEluL04Yo9aAEaAE2qTFLXe/h2yKX5h61aFq6bBnnH/PA/XQWTDz8hwX3wyVZKWRcfnFCqlpg==]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
chatStatus 1:人工对话开始 2:人工对话结束 3:留言开始 4: 留言结束 5:机器人对话开始 6:机器人对话结束

chatData(对话数据)

属性 含义
chatRecordId 对话记录的ID,唯一值 例如:1_5987809
chatEndTime 对话结束时间 例如:2016-01-09 17:54:58
chatEndType 对话结束方式 0-未知,1-访客结束对话,2-客服结束对话,3-访客超时,5-客服退出,6-系统关闭,8-访客长时间未回复结束,12-忙碌放弃结束,14-留言超时结束,15-机器人自动转人工结束,16-机器人手动转人工结束,18-客服主动对话后留言/机器人对话结束
chatTotalTime 通话时长 单位:毫秒
chatWaitTime 等待时长 单位:毫秒
firstAnswerTime 首次响应时长 单位:毫秒
avgAnswerTime 平均响应时长 单位:毫秒
visitorSendMsg 访客发送消息条数
staffSendMsg 客服发送消息条数
perfectMatchs 完全匹配数(机器人对话)
exactMatchs 精准匹配数(机器人对话)
similarityMatchs 相似匹配数(机器人对话)
misMatchCount 未命中数(机器人对话)
solvedCount 点击解决数(机器人对话)
unsolvedCount 点击未解决数(机器人对话)
activelyInviteEvaluating 是否邀评1: 有邀评 0:没有邀评

staffKpis(客服kpi数据,如果当前对话经过过转接则会有此节点,如果对话只有一个客服服务那么请使用chatData中的avgAnswerTime等信息作为客服的KPI数据)

staffKpi:

属性 含义
staffId 接待对话的客服ID
staffLogname 接待对话的客服登录名
staffName 接待对话的客服姓名
firstAnswerTime 首次响应时长 单位:秒
avgAnswerTime 平均响应时长 单位:秒
visitorSendMsg 访客发送消息条数
staffSendMsg 客服发送消息条数
duration 总通话时长

3.2.3 对话接通
GET参数追加:dataType=chatAnswer
排队接通的对话会有此事件下发

请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=chatAnswer

POST内容:对话评估的XML信息
明文XML示例:

<xml>
<chatStatus><![CDATA[1]]></chatStatus>
<chatData>
<chatAnswerTime><![CDATA[2016-01-09 17:54:58]]></chatAnswerTime>
<chatWaitTime><![CDATA[16]]></chatWaitTime>
<chatType><![CDATA[1]]></chatType>
<chatStaffId><![CDATA[14]]></chatStaffId>
<chatStaffLogname><![CDATA[13128888888]]></chatStaffLogname>
<chatStaffName><![CDATA[一洽客服]]></chatStaffName>
<chatStaffRole><![CDATA[超级管理员]]></chatStaffRole>
<chatRecordId><![CDATA[5987809]]></chatRecordId> 
<chatDepartmentId><![CDATA[11]]></chatDepartmentId>
<chatDepartmentName><![CDATA[订单组]]></chatDepartmentName>
</chatData>
</xml>

密文XML示例:

<xml>
<Encrypt><![CDATA[pcf0D1yQAvtOjRmwjkxHLuIjUFmA3AP+A2YKXxIerq5p/lh7URAmAXsxXJUJ4wu8kOkW/JGB9dyf7qmJYXMmv2TIyWSmDhhK1GXhZUHHBTyyWHieZaBUBPkT5EG3Vb/vX5amZE63vJllzyvDB9JD5MLoOyCS8O5JkPAWrVBGdFoa8VAEjEJHdSlDabyJ8h7QxX40z7002eAbZjwPtschrtVQjZd5j4U1e/NE5ryXq2jwljAC1WZHJb2F1K3nv+tKZuYQDltFxcE1LMA1m/b62allzqZ0ChYPsonSVcT7WtGLZAKqZktjO922qmsmfMeLBW4mO2Nw+D767W+9BUnucA==]]></Encrypt>
</xml>

XML属性解释

属性 含义
chatStatus 固定为1,对话开始

chatData(对话数据)

属性 含义
chatAnswerTime 对话接通时间,格式:yyyy-MM-dd HH:mm:ss 2016-01-09 17:54:58
chatWaitTime 访客等待时长,单位:秒
chatType 会话类型 1-在线对话,3-离线消息,5-机器人对话
chatStaffId 接待对话的客服ID 人工对话有效
chatStaffLogname 接待对话的客服登录名 人工对话有效
chatStaffName 接待对话的客服姓名 人工对话有效
chatRecordId 对话记录的ID,唯一值 例如:1_123321
chatDepartmentId 本次分配对话的分组ID,如果是全部人员可接待则ID为0
chatDepartmentName 本地分配对话的分组名称 例如:订单组

3.2.4 对话转接
GET参数追加:dataType=chatTransfer
对话转接会有此事件下发

请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=chatAnswer

POST内容:对话评估的XML信息
明文XML示例:

<xml>
<msgId><![CDATA[39086101]]></msgId>
<tm><![CDATA[1563851906863]]></tm>
<transferData>
<chatRecordId><![CDATA[1_5987809]]></chatRecordId>
<transferTime><![CDATA[2016-01-09 17:54:58]]></transferTime>
<fromStaffId><![CDATA[16]]></fromStaffId>
<fromStaffLogname><![CDATA[13128888888]]></chatStaffLogname>
<fromStaffName><![CDATA[一洽客服01]]></chatStaffName>
<toStaffId><![CDATA[16]]></toStaffId>
<toStaffLogname><![CDATA[13126666666]]></toStaffLogname>
<toStaffName><![CDATA[一洽客服02]]></toStaffName> 
</transferData>
</xml>

密文XML示例:

<xml>
<Encrypt><![CDATA[pcf0D1yQAvtOjRmwjkxHLuIjUFmA3AP+A2YKXxIerq5p/lh7URAmAXsxXJUJ4wu8kOkW/JGB9dyf7qmJYXMmv2TIyWSmDhhK1GXhZUHHBTyyWHieZaBUBPkT5EG3Vb/vX5amZE63vJllzyvDB9JD5MLoOyCS8O5JkPAWrVBGdFoa8VAEjEJHdSlDabyJ8h7QxX40z7002eAbZjwPtschrtVQjZd5j4U1e/NE5ryXq2jwljAC1WZHJb2F1K3nv+tKZuYQDltFxcE1LMA1m/b62allzqZ0ChYPsonSVcT7WtGLZAKqZktjO922qmsmfMeLBW4mO2Nw+D767W+9BUnucA==]]></Encrypt>
</xml>

XML属性解释

transferData(转接数据)

属性 含义
chatRecordId 对话记录的ID,唯一值 例如:1_123321
transferTime 对话转接时间,格式:yyyy-MM-dd HH:mm:ss 2016-01-09 17:54:58
fromStaffId 发起转接的客服ID
fromStaffLogname 发起转接请求的客服登录名
fromStaffName 发起转接请求的客服名称
toStaffId 接受转接的客服ID
toStaffLogname 接受转接的客服登陆名
toStaffName 接受转接的客服名称

3.2.5 对话内容
GET参数追加:dataType=chatContent 或者 leaveMsgContent
chatContent:对话内容
leaveMsgContent:留言内容(crmData只在此数据下下发)
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=chatContent

POST内容:对话评估的XML信息
明文XML示例:

<xml>
    <msgId><![CDATA[39116641]]></msgId>
    <tm><![CDATA[1563864914001]]></tm>
    <chatData>
    <chatRecordId><![CDATA[1_5987809]]></chatRecordId>
    <chatContent><![CDATA[对话开始 >>2016-08-17 10:47:01.0\n访客>2016-08-17 10:47:08\n您好\n访客>2016-08-17 10:47:09\n您好\nElla>2016-08-17 10:47:13\n您好\n访客>2016-08-17 10:47:24\n想詢問自動應答功能 \n访客>2016-08-17 10:47:34\n是否可以多新增幾個呢\n访客>2016-08-17 10:47:46\n如30秒回復一個內容\n访客>2016-08-17 10:48:00\n90秒再回復一個呢?\nElla>2016-08-17 10:48:08\n您好,只能设置一次\n访客>2016-08-17 10:48:38\n因回覆內容不同 這樣設置有些不便\nElla>2016-08-17 10:49:18\n您公司ID是多少呢?\n对话结束 >>2016-08-17 10:51:12.0\n访客关闭对话]]></chatContent>
    </chatData>
    	 <crmData>
		 <visitorId> <![CDATA[web1435360447]]> </visitorId>
		 <name> <![CDATA[一洽技术1]]> </name>
		 <gender>0 </gender>
		 <age>0 </age>
		 <maritalStatus>0 </maritalStatus>
		 <phone> <![CDATA[123456]]> </phone>
		 <qq> <![CDATA[123456]]> </qq>
		 <wechat> <![CDATA[12345]]> </wechat>
		 <email> <![CDATA[123456@qq.com]]> </email>
		 <nation> <![CDATA[中国]]> </nation>
		 <province> <![CDATA[广东省]]> </province>
		 <city> <![CDATA[深圳市]]> </city>
		 <address> <![CDATA[南山区]]> </address>
		 <memo> <![CDATA[优质客户]]> </memo>
		 <c1> <![CDATA[商户咨询]]> </c1>
	</crmData>  
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[pcf0D1yQAvtOjRmwjkxHLuIjUFmA3AP+A2YKXxIerq5p/lh7URAmAXsxXJUJ4wu8kOkW/JGB9dyf7qmJYXMmv2TIyWSmDhhK1GXhZUHHBTyyWHieZaBUBPkT5EG3Vb/vX5amZE63vJllzyvDB9JD5MLoOyCS8O5JkPAWrVBGdFoa8VAEjEJHdSlDabyJ8h7QxX40z7002eAbZjwPtschrtVQjZd5j4U1e/NE5ryXq2jwljAC1WZHJb2F1K3nv+tKZuYQDltFxcE1LMA1m/b62allzqZ0ChYPsonSVcT7WtGLZAKqZktjO922qmsmfMeLBW4mO2Nw+D767W+9BUnucA==]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
chatData 对话内容父节点
chatRecordId 对话记录的ID,唯一值 例如:1_5987809
chatContent 对话内容
crmData 用户数据的父节点:只在leaveMsgContent数据中下发
visitorId 访客的唯一值 例如:web123456
category 客户类别 例如:意向客户
name 客户姓名 例如:王宝强
nickName 客户的昵称 例如:宝宝
gender 性别,0-未知, 1-男, 2-女
age 年龄
birthday 客户生日 例如:2015-08-01
maritalStatus 婚姻状况 1:未婚 2:已婚 0:未知
phone 客户电话号码
qq 客户qq号码
wechat 客户微信号
email 客户邮箱地址
nation 客户所在国家
province 客户所在省份
city 客户所在城市
address 客户地址
photo 客户头像地址
c1-c20 自定义字段
memo 客户信息备注

3.2.6 对话评估
GET参数追加:dataType=chatSubject
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=chatSubject

POST内容:对话评估的XML信息
明文XML示例:

<xml>
    <msgId><![CDATA[39116641]]></msgId>
    <tm><![CDATA[1563864914001]]></tm>
    <chatRecordId><![CDATA[1_5987809]]></chatRecordId>
    <chatSubject><![CDATA[售后>订单>物流]]></chatSubject>
    <chatSubjectMemo><![CDATA[客户要求换货,拒绝维修]]></chatSubjectMemo> 
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[pcf0D1yQAvtOjRmwjkxHLuIjUFmA3AP+A2YKXxIerq5p/lh7URAmAXsxXJUJ4wu8kOkW/JGB9dyf7qmJYXMmv2TIyWSmDhhK1GXhZUHHBTyyWHieZaBUBPkT5EG3Vb/vX5amZE63vJllzyvDB9JD5MLoOyCS8O5JkPAWrVBGdFoa8VAEjEJHdSlDabyJ8h7QxX40z7002eAbZjwPtschrtVQjZd5j4U1e/NE5ryXq2jwljAC1WZHJb2F1K3nv+tKZuYQDltFxcE1LMA1m/b62allzqZ0ChYPsonSVcT7WtGLZAKqZktjO922qmsmfMeLBW4mO2Nw+D767W+9BUnucA==]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
chatRecordId 对话记录的ID,唯一值 例如:1_5987809
chatSubject 对话评估的主题 例如:售后>订单>物流
chatSubjectMemo 对话评估备注 例如:客户要求换货,拒绝维修

3.2.7对话满意度评价
GET参数追加:dataType=chatScore
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=chatScore

POST内容:对话评估的XML信息
明文XML示例:

<xml>
<chatRecordId><![CDATA[5987809]]></chatRecordId>
<chatScore><![CDATA[5]]></chatScore>
<scoreDimension><![CDATA[产品,服务]]></scoreDimension>
<scoreSuggest><![CDATA[产品很棒,客服的服务更棒!]]></scoreSuggest>
<chatStaffId><![CDATA[14]]></chatStaffId>
<chatStaffLogname><![CDATA[18098933897]]></chatStaffLogname>
<chatStaffName><![CDATA[郑丽文]]></chatStaffName>
</xml>

密文XML示例:

<xml>
<Encrypt><![CDATA[F3ojdKrzWIGB+2YVHlBtl+6TXDUBqW2feUcmB3TzVhPyVwnphnAra/wNH5H5NiF/fVaIbM1wCBuvzKCo6E0FBEz1nCwxJUmpQ5cCIZ0BKh+6+7Wp4iAeVN+NoHz0ufWqy3vJ8r7TMApOiTaIsbfGHG3AsN2aKjetC58x14Tq5VEa3WxZAbJm83E0FQ5mhRSWOLCf23x86elu69zPlgUp/rmWwelFCAi1S3Cx9EpaF2MQHUt7BrFU6/kmWLKOCt2pls+UEfWuqFtrqVHa32b+UGIA7ke835fv1ePcZR8wpzwtpzaVPujnpOxdh+DzJ2iriXA6Sz5iQZDF7gDlag/NzBQdTZ3XegyKBuRev+Fn6e9poBKXM4yF+nkh5+U6Y04P]]></Encrypt>
</xml>

XML属性解释

属性 含义
chatRecordId 对话记录的ID,唯一值 例如:1_123321
chatScore 满意度评价,1-非常不满意,2-不满意,3-一般,4-满意,5-非常满意
scoreDimension 评价维度 例如:产品、服务、物流
scoreSuggest 评价的内容
chatStaffId 评价发生时正在接待对话的客服ID,如评价时对话已结束则无此信息
chatStaffLogname 评价发生时正在接待对话的客服登录名,如评价时对话已结束则无此信息
chatStaffName 评价发生时正在接待对话的客服姓名,如评价时对话已结束则无此信息

3.3 客户数据
① 客户数据提交后会POST到接收方的接口中。 ② 提交客户分配下发POST到接收方的接口中。
GET参数追加:dataType=crmStatus
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=crmStatus
			

POST内容: ① 客户数据提交后xml信息
明文XML示例:

<xml>       
    <msgId><![CDATA[39086101]]></msgId>
    <tm><![CDATA[1563851906863]]></tm>
    <visitorId><![CDATA[web377724523]]></visitorId>
    <crmStatus><![CDATA[1]]></crmStatus>
    <staffId><![CDATA[14]]></staffId>
    <staffLogname><![CDATA[18098933897]]></staffLogname>
    <staffName><![CDATA[郑丽文]]></staffName> 
    <crmData>
    <visitorId><![CDATA[1314521]]></visitorId>
    <category><![CDATA[意向]]></category>
    <name><![CDATA[王宝强]]></name>
    <nickName><![CDATA[宝宝]]></nickName>
    <gender><![CDATA[1]]></gender>
    <age><![CDATA[36]]></age>
    <birthday><![CDATA[2015-08-01]]></birthday>
    <maritalStatus><![CDATA[2]]></maritalStatus>
    <phone><![CDATA[18990987546]]></phone>
    <qq><![CDATA[9876389]]></qq>
    <wechat><![CDATA[echatsoft]]></wechat>
    <email><![CDATA[9876389@qq.com]]></email>
    <nation><![CDATA[中国]]></nation>
    <province><![CDATA[广东]]></province>
    <city><![CDATA[深圳]]></city>
    <address><![CDATA[深南大道金融街]]></address>
    <photo><![CDATA[http: // www.baidu.com/mypic.png]]></photo>
    <c1-c20><![CDATA[自定义字段]]></c1-c20>
    <memo><![CDATA[娱乐明星]]></memo>
    </crmData>
</xml>

POST内容: ② 提交客户分配下发xml信息
明文XML示例:

<xml>
    <msgId><![CDATA[39086101]]></msgId>
    <tm><![CDATA[1563851906863]]></tm>
    <visitorId><![CDATA[web377724523]]></visitorId>
    <crmStatus><![CDATA[1]]></crmStatus>
    <staffId><![CDATA[14]]></staffId>
    <staffLogname><![CDATA[18098933897]]></staffLogname>
    <staffName><![CDATA[郑丽文]]></staffName> 
    <ownerData>
    <ownerId><![CDATA[4443]]></ownerId>
    <ownerLogname><![CDATA[yangtong@echatsoft.com]]></ownerLogname>
    <ownerName><![CDATA[王宝强]]></ownerName>
    </ownerData>
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[FtwduBHlEd7OtmFkm5G5KFHQoaGPyTbSaL3P9ifkNHI71liOrABT0TJI6pDaBl4raBSMwVhsOsiIMaYbb4C6NMDOCKMZE5nltDaazVTUfMRdL/feVuyhOM2nG0xCu6YipmJVzix2W4fbCasvQt9xJmOeBXsPh9zI4F3jABwuMLv7rNj3OeaNFa9Td5YDIvPmLrZg/j/JMofD0mH4GpUm7qosvQTWBAugRRQTjfqqNJee460QvJRDCDuDdrI2nKpv8z+HLuc3QuMwVfJcQ+4/J8+be5QSDmYOTZFg/wgR10ELXTfTtv9vEtRT443nzLSvUgjaFyLwu1NvHub8zDqEYIWSoYUJU+XrAuou/5ZYKaeErUJKZsD26tT51qk/ItDs3Ts+yiUTTe1BumwIw0zdndncWCSSC2WTrTFViIo7Hptrun640k5S7aOAXdwxudziaQvv52ICwpKx/g9TshkEq/ZxMCdWjcmvnnU5tB0oinAb4Ovrfx/erpBnYZ5fzszSQ3IWY5Xvs9RciTDomRW2WAjFjivcOn0LxpZjRpXkzpMHptx/cQK0ul7Bw6tVwh5n7UhX4/cmmOGsw729vqaNh6U74FJ9J3ucdqkjCUnQPKHz1BLEDxE6llIobdmiuPC/rSpLWgogrDl6suOm3LqY2VjTdf7zHTXJ6iRHSXzZSikoP8Dze9Ee39OHgjYaVCyvio/rWD27FUqNqDh4SC8YFE5jIy1rkmEcVLKN6IUd8POrCChg9i9B3NbmKXtxhZlNIS0wJt3FOOL5S++OftJ4bNKdQzrnmR/NTFcb8DpeFSMYWZ/TO4jd3FyuZZADWf1jqV3PuRZa3kIoGpO9a2dmV88va7o9DmYD+NXcIwBCIQnhpDUILOx9eiyOb22kb0eUJTcBi2E2rBcd+tYOMfZ/redj6V336B0BqMXro78nFmyjvtU0PlNBVolCZQirif8ODdvHVdvObYnXU9ldcXsCIZ+2OfFPY54+RLxSZ4in9JiL9SdFmv85AGcAGDiyOmBtegdOnxwAIzC2IdqtsstNwnkNZzDAg8XQwdY4SaaoFg4HnGhd1oMuKHoOkKOx6mxgnD+2JfEFCfVjKi/qhnrLvq31EcK6thn8k2jSrMKTLfOhPlpLDYE78qMFM9yWtIjf1EcuPm7JjR8ZWyFxxi5jGophWU4/I6He2rJ4mh0TKL9y+7qyvQsukgaC/rk4xKHNDpIYHWlZmrrU2oJq2RuIH2E+Q5pTJ/J5tBoUhnS0PNNAmqu/6xCQLOsEb0IVTq+f]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
visitorId 访客的唯一值 例如:web123456
crmStatus 把CRM数据发送到第三方的API接口1:访客在信息收集窗口填写了数据,对话开始后会自动触发2:客服手动在一洽CRM系统填写了客户信息,并点击了“发送至接口”手动触发 3:客服将客户确认分配人后触发
staffId 发送数据的客服人员ID
staffLogname 发送数据的客服人员登录用户名
staffName 发送数据的客服人员姓名

ownerData 数据

属性 含义
ownerId 所有者的ID
ownerLogname 所有者登录的用户名
ownerName 所有者姓名

crmData(CRM数据)

属性 含义
visitorId 访客的唯一值 例如:web123456
category 客户类别 例如:意向客户
name 客户姓名 例如:王宝强
nickName 客户的昵称 例如:宝宝
gender 性别,0-未知, 1-男, 2-女
age 年龄
birthday 客户生日 例如:2015-08-01
maritalStatus 婚姻状况 1:未婚 2:已婚 0:未知
phone 客户电话号码
qq 客户qq号码
wechat 客户微信号
email 客户邮箱地址
nation 客户所在国家
province 客户所在省份
city 客户所在城市
address 客户地址
photo 客户头像地址
c1-c20 自定义字段
memo 客户信息备注

注:客服更新操作为保证及时性一洽每更新一个字段就会向数据接收方post一条数据 例如:修改姓名为空

<xml>
    <crmStatus><![CDATA[2]]></crmStatus>
    <staffId><![CDATA[14]]></staffId>
    <staffLogname><![CDATA[18098933897]]></staffLogname>
    <staffName><![CDATA[郑丽文]]></staffName> 
    <crmData>
    <visitorId><![CDATA[1314521]]></visitorId>
    <name><![CDATA[]]></name>
    </crmData>
</xml>

3.4 浏览数据
访客进入企业网站到离开企业网站,一洽回向数据接收方推送三种数据:访客进入、访客离开、访客轨迹

3.4.1访客进入
GET参数追加:dataType=visitorEnter
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=visitorEnter
			

POST内容:对话开始的XML信息
明文XML示例:

<xml>
    <msgId><![CDATA[37122226]]></msgId>
    <tm><![CDATA[1563867929683]]></tm> 
    <myData><![CDATA[network=wifi&game=斗地主&ver=9.2&os=ios10]]></myData>   
    <metaData>
    <uid><![CDATA[1314521]]></uid>
    <grade><![CDATA[1]]></grade>
    <category><![CDATA[金牌会员]]></category>
    <name><![CDATA[王宝强]]></name>
    <nickName><![CDATA[宝宝]]></nickName>
    <gender><![CDATA[男]]></gender>
    <age><![CDATA[36]]></age>
    <birthday><![CDATA[2015-08-01]]></birthday>
    <maritalStatus><![CDATA[2]]></maritalStatus>
    <phone><![CDATA[18990987546]]></phone>
    <qq><![CDATA[9876389]]></qq>
    <wechat><![CDATA[echatsoft]]></wechat>
    <email><![CDATA[9876389@qq.com]]></email>
    <nation><![CDATA[中国]]></nation>
    <province><![CDATA[广东]]></province>
    <city><![CDATA[深圳]]></city>
    <address><![CDATA[深南大道金融街]]></address>
    <photo><![CDATA[http: // www.baidu.com/mypic.png]]></photo>
    <memo><![CDATA[娱乐明星]]></memo>
    </metaData>   
    <visitorData> 
    <visitorEnterTime> <![CDATA[2020-04-09 10:53:14]]> </visitorEnterTime> 
    <visitorMedia><![CDATA[5]]></visitorMedia>
    <visitorType><![CDATA[4]]></visitorType>
    <visitorId><![CDATA[wechato6ohSwjIVENM7ZbBqPypRyu4D_zA]]></visitorId>
    <visitorName><![CDATA[王宝强]]></visitorName>
    <visitorPhoto><![CDATA[http:// wx.qlogo.cn/mmopen/WncXm]]></visitorPhoto>
    <visitTimes><![CDATA[5]]></visitTimes>
    <visitorLan><![CDATA[zh_CN]]></visitorLan>
    <visitorIp><![CDATA[122.96.185.139]]></visitorIp>
    <visitorCountry><![CDATA[中国]]></visitorCountry>
    <visitorProvince><![CDATA[广东]]></visitorProvince>
    <visitorCity><![CDATA[深圳]]></visitorCity>
    <browserName><![CDATA[QQ浏览器]]></browserName>
    <browserVersion><![CDATA[9.0]]></browserVersion>
    <screenResolution><![CDATA[1920*1080]></screenResolution>
    <osName><![CDATA[Windows]]></osName>
    <osVersion><![CDATA[7]]></osVersion>
    <se><![CDATA[baidu]]></se>
    <keyword><![CDATA[在线客服软件]]></keyword>
    <biddingWord><![CDATA[在线客服软件]]></biddingWord>
    <keywordType><![CDATA[]]></keywordType>
    <referPage><![CDATA[http://www.baidu.com/baidu.php?sc.WwCK00j7A0GeyEPIcgU]]></referPage>
    <firstTime><![CDATA[2016-01-09 17:53:32]]></firstTime>
    <firstPage><![CDATA[http://wx.qlogo.cn/mmopen]]></firstPage>
    <firstPageTitle><![CDATA[一洽软件的价格]]></firstPageTitle>
    <lastChatTime><![CDATA[2015-07-08 11:23:36]]></lastChatTime>
    <lastChatStaffId><![CDATA[14]]></lastChatStaffId>
    <lastChatStaffLogname><![CDATA[218098933897]]></lastChatStaffLogname>
    <lastChatStaffName><![CDATA[郑丽文]></lastChatStaffName>
    </visitorData>   
    <routeData> 
    <routeId><![CDATA[72]]></routeId>
    <routeName><![CDATA[一洽]]></routeName>
    <styleId><![CDATA[201]></styleId>
    <styleName><![CDATA[一洽网站]]></styleName>
    <chatDepartmentId><![CDATA[11]]></chatDepartmentId>
    <chatDepartmentName><![CDATA[订单组]]></chatDepartmentName>
    <routeStatus><![CDATA[1]]></routeStatus>
    </routeData>  
    <trackData>
    <trackRecordId>123456</trackRecorId>
    <visitTimes>3</visitTimes>
    </trackData>
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[XEki0sFhQHZnnlWcz8Gz8ZrBez3ZxBXYq+qhycqvBNtNLIWud+GLMQO0ZInmuJMYPjAA2MtAv8h4INyzsqemM3uo9hUq8zqX9GPpWwDZTpu3WDU4QDoYCx52v2H5ghYmqb6L6m49zaxI1BBYxuj9J3RKDltum5gYWnYHLKq4CXARTVb/lus1kfGzEbGZyB35JPtHqXz05BrYLg3SFwgcXbOLpSm8Q6b6rFfiOfeKdYPbUb48dhBLifG0lxSoZ2NBlIVotwvlIVlqEnPhpcN0d2wg2I83RzwCn9K4ohuUkGcQ4/mLHvSUmhI8TW/W9gkas3UWuQ214ZFjKsvq4cEuPDcH+UTNR5EiYipX5eOjabb1Pz7Zun3zDiX5HJTYXkrKkdE9qe/pl//OHlZCi1Kpqz91essRGb1IK+F4oCMeP9cPQji+tQ7C7MfkxUmTDR+wiOjVHbniGJ/gbWra8d6a/LDNCK3HKqPzFc7r8kCHs7ZdURWNbxc/NSyqyyNN2xuT/mxTpM59BuODa4dH0ReqWm3OiXN7onQN0yCD5qWDEn9l31QtmGU7KjJsP7AEmTaRc874kNd4xFrEaiXoI5AiigPYmd3BjrMEIPg3nXlcP7xEjVMLxlRF+WUs+72g+OyaCC8o05oCq6AZ6Zrn6fY1/3QAqvlH+pAPjenjgWY3/x22w26SU8+LWmvhVLYsn+3JFlRvPlASoa8OYru1KZfdP9/d61HVytmOiYHF7iMSmV0f9M5l4B0ld4aeHqUMTZ+3wceRH6WzFPWpzUAMweEa/cq0QAlpTsW0Zd8I39z1YK4XFh2A0sQfMB5UTmzJsn8MSW4rsrP6g72BlYqQGzp19F6r4WID4NLFZ8/wpw+7AdrW02e6r7rSuFNPstagpB95tjHlb114ajjgONkN6Z6maURllOWHGa1eDWqjvNECT/Qgj7KFv1AheevCvVL1lIRKF95tLYCe6gDGeD4aEzRrzF+T0qur6e/jNewBb9vePidEU6eGGesrc/RhCpz122Uu1J5002yO1/mfjhzSX4/nKJCH7mHYxC7UlOAfbLzDWzuMLnMrlvZ0pxEjdWvrti9hhF1JJNfhtcin/P8aEc9aZlMQBrT0BGGKwqHYsAgW/m33cx7wdjVwywKupDVj8m6QYXub8LSE+BpNjTNLdhajedJNQaCdAnOzbkeoifFstfhLpvetBtigkKeDTnIe2k2FaPp1Ompg9/nm2C92FM8/UB6jYDj3PJQPsnWu/HYK4sx2Vn2P/A2EzjJmKmuqoZm3eu5cZBeUI0m3gPqQ0jdQmfKFH7Mn8jYZgrhgYGe+bdIuXctsGmxO01SVMlFpzlmADmQ7tGf0wVtsg4y64ofmQ0CrfeSOqKxc9UHQ5S0n5d/1nPWz4ZaUcTMgNsckP/A+H/2lmkDdAaZ0Pw584FzIEcfXssbBioy54YHBM/An9zsLUwVLqjIoMHyHRw2OK/evQYAZFhfp758c+kHX702QUcbBuxxyNVBmonYu+NjRzLyck2Cqwd7p0pKXzspYHI8yD95ao4qdMZngnnsKVjim9zFYIurA5vwv64nPukBM1WbFnAuDuMFSx/1qLhxz8YVZjDMiY35KEoVmhWGv6AzN0i2IB3lxz1EKDbZxWJ1pkiy9drFu2aSZFntd98rQhPt7zG4RbT+yhzhyUgXrIkhtI4LVgfHc/lil7bNtkhuYutZzJmuS0cJOVN2oChWPBhXPYs0tVlJ+PcSocT2W7ttcTrcqfnB8IKYG0xDLmi5yJW5xkDkrRNvfbEH9a1VkJeRVFGNXTMSn+lChQXBYox0ccJ2bjUMeMh2Zrze8ygn1EDL6ehzh0tOb4b2SKOKj35Te7BtjHaGn1Ly6PfcsKcL0MNaGDZH01vs5L715PNMbDrUVQvoDFjxp4Eyov3yPpM9fDpVUuafAROiwp3gF1NqH0lwxu5ISznghK4SVUPmDDnv+Ss6X8LBnoupturOJpzY5crQEUqD5JRjLXf31mfI0tG4SL84FTDzCLWzJ0j8j0G4AQENhB77ISrHwvffGLuoOqoOHRaalpZcBGVHtQm4TVJ3foBKnvbXdMcw/uU4G2AXqa/fJ/kcUUyqbg/FDVTDJPJNAC3XWJNQWmPmq4mg9cwt4vPYsSZFqrLBUUr2DMA1RPu5sKuvtOeFm7jUqpDYtHwcc8txBKnsW6hJeLlCs1FF1XfOaxVI4Eb58NtfvTB6j4/rVuBK3sRQniAiYD2KQbvcWQ8sw2tABOBbAB3Saqw9y9E6RkoZ23yuaoZyeVjzSwxanlRU6v+WtzK4SUMjl/G+RM557BDWfaL8jpjpGG01Uwj9AYeNGz5hzvekAw8QL9BYG4oujBhiysUxBMqk75gz0rw6QaMpiPa3G/IvSWf067d5Ly3vzrummu84xBlOaRsglvilMKcpxNurPImOCi5/QQphkRGRe6Nd+1vfmfhmGbmHhO48zIKHazhz6EpOcCdByydTvC9va0VDreom+1hLASoenUxNp0gaNsFWwHt13qKY7V72tAJvZzJUbyQTab0JLqeuT7ZRlmbBJ7aaiwDRbLDrVdGaU5Y7J6SKOW1vAdTtSscjCxvTRVT1mTCWjl7VJy2E7yvJ4BhxE1UL744rUqeAH8Y7hToHpSo6Qjdv1awJxhh6thlQ6onQLRzmxbZRFoxw5r/ySY9NdWLmXkWxuqU8A40PSCdHFsk4PS2vaL+LfhFLiM4l+c4PXhkuBf8rOqIG++7c5sZvU345IXjHmCclvrSXoQFzQVyimqGe8Z6KSLTRSZO5z6x2YIDl0uG5q75cl2RWheRfUEPllI++5pO86thHYHZAoDxi6Tr2xnwXYXV+KvxJK9skvb1MljOZmGkONsDAK7XMAp8IPc38yCvX5CU5ab0G1nuKdLQmnJzLFb+lLJS6q9olYaWMF9CGfa7C6HJFtmnN3Epbw6kusRy3aPixz8SSKO30wYZfdQ4eWm952G7IbVoBLZSDTA1/hVfJHx4BM2V+h285cMoe0cSeqQXxD5UY26ekI7ptde3pw49NEzEl1BU3cnKATzL6ONnAjVnilaCWySU85tYJhthvfEaN5VJFNu17t0ZTk4lGDaTRdVcJ9lsQIsnJy6xq9jKLKkTmXWptTwb/UzS73wxT8/Tu2lIx4RlWeeXKZdRs+pQOamCSa0WBWyXtEaB4DXjI3tDRyMWRGWWDhCsrt+IIYSBzcAEmvCzT/iybLJeUnZ44akzGwTAM2AgeKlGjjc8DVqnE+V5uemM4avb+n0wgyKMDF/96SVGNZEqWJOzYd100nZ//OXQvV+1U3xFbfpIHkkiIg3AY9VXQ7q9EPc7K32cyV+/R5adZbfpWgHY6z3Inod0CZse0u0d712F+VetGNWZGOmq+2p6t5N9BmKnqYvhk/jT8i5XviZv9TIHhEW5kbSZKQzHCUqoxTfnPVw+LOFJFQNwQlQ3ASC0VqJnoN+7fcWyOTCY8au0WFgu19ZV/OjWkIrttV4eu8VsC+NcJmoGBX6z4A5XVt9+2qdF+khSGwwiD97sIANfJ52QOETfnCTq38VtYLS9bEvBpuOrICVMqmELyLC8A/NSWKe10R79wM4kKsK7gSBfrZCWM6yZe29K0bAi+ISn/2AkkrhNx2WVFmRFANRouaIt6PmrMqXPe5Wg3t8f5z8TcYTejQFjR2Cxwlou+7OqeBiUapVIpmTG3KQr4I8EDSJGZ4ZVtUTRhsDAAl2gsGj5qM8zrcxjXuCcTiQXk9z/MimHzg+WC3gudZQ8kiOe2duFZqOyhPo0/G9ovblm2vIBar0hHzPYGFwOAXUHYpiCkC0YDfINgBTxPDv3NskXQCWnXJDtJWECEMIvGHWevlHiEXS0qCSEA7iB2BYP1qAdWgYlyx95Zbjm3eLPIYW/B5bvAuJyFB0Xxw5efeA7+9L2/DIL45/jWKKjvrFjKrRvDD3xf5BzjmhXBs62a9cyr6q0huKRnLiJvaXuf9cyePQYnGPiCor8/NPK5NwiEiJs+/6ib50EsxCVqHA0o+5ZpZx8xQi1R/62fAi/eZ8P7TWAcuwBomLNgPIh+sKnsMmCJyyJOkxgFzj0xDQ7JVjt8MJWu1MydKwW1OUlBBQ64Q/tmxSG8MWHEOBrdCZngbMFKYyOfTU3+VVYnyTS4oxeU3aqu/yeZLHGlkCPBl1RImKGROL2+mTKYnXxXyBnnr2jzH0/s911IyzkkwaQ1asVTJYBuyFVLfb3UYQk5j3GuTr15D6rzHdtKtnq4GqxaSniz7utIudTYTKvPe5wfQMr8vhMYBQcHIjv8gTG3gy7MweEnj4LD6xIvvZByPpaahw03VmN/E8ygR+WeqUOzevnrJGFU2z9CO/lSf0o6OzfyCPnLYfMnHoqOXP0NMujAKTBS7QC59kk8a/I9umkn4DnutGhgMXQbZDvl9nATZkt6MJfND0+XkjkHSY9GbcjTvde5tKQ9o9ZX7cXG2TXzL5zRl]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
myData 开发者自定义扩展数据,如果打开对话时加了这个参数则传递该数据
metaData (会员数据,如果是会员则传递该数据),同对话开始数据中的metaData
visitorData 访客数据,同对话开始数据中的visitorData
routeData 路由数据,同对话开始数据中的routeData

trackData(浏览数据)

属性 含义
trackRecordId 此次浏览轨迹的ID,浏览记录唯一值
visitTimes 当前访客此次是第几次来访

3.4.1.1 关键字数据

百度屏蔽了竞价和SEO的关键字传递,一洽可通过和百度的合作对关键字数据进行抓取,在获取到访客的搜索关键字后会单独下发给开发者。

事件类型:keywordReturn

请求地址实例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=keywordReturn

POST内容:访客关键字xml数据
明文XML实例:

<xml>
    <msgId><![CDATA[37122226]]></msgId>
    <tm><![CDATA[1563867929683]]></tm>
    <trackRecordId>123456</trackRecorId>
    <se><![CDATA[baidu]]></se>
    <keyword><![CDATA[深圳大学]]></keyword>
    <biddingWord><![CDATA[深圳大学]]></biddingWord>
    <keywordType><![CDATA[1]]></keywordType>
</xml>

XML属性解释:

属性 含义
trackRecordId 此次浏览轨迹的ID,浏览记录唯一值,和visitorEnter中的ID关联后补充关键字信息
se 访客来访的搜索引擎 例如:baidu
keyword 访客来访的搜索关键字 例如:一洽软件
biddingWord 推广词 例如:一洽软件
keywordType 点击类型, 1:SEO 2:竞价

3.4.2访客离开
GET参数追加:dataType=visitorOut
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=visitorOut
			

POST内容:对话结束的XML信息
明文XML示例:

<xml>
        <msgId><![CDATA[37122226]]></msgId>
        <tm><![CDATA[1563867929683]]></tm> 
        <routeStatus>2</routeStatus>
        <trackData>
        <trackRecordId>18198</trackRecordId>
        <visitPageCount>1</visitPageCount>
        <visitTotalTime>262728</visitTotalTime>
        <chatRecordId><![CDATA[1_12024,3_2800,3_2801,5_1498]]></chatRecordId>
        <giveupRecordId><![CDATA[21584,21585,21586]]></giveupRecordId>
        <visitorOutTime><![CDATA[2019-07-23 16:20:11]]></visitorOutTime>
    </trackData>
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[gUHc0D73LA5oHk+mfxqebcitJQGnoIUjYfSt2OzBIhoGQ3WU8RP0hVDFusA2CJN+wpZl4Wn/0wwjrK9+Nq4bP5+J8D1iSr610av5rvBrWPqV+ukvQYKR13msx7h/xDCBRu6txKQvgXVcTMiYZgj93mP/zWm9DU8ltWr8cZPwP1Xta692Qz1CSjInxuh2QC0dtVuL+3/abqvG7ZB6ZYhruvfQOD4VxHe6QfyBYWszgn+ptxB6drMWn8IHzed0L9MbCZcpk7jLv1pltsnpYJIcPfOrA5Tu9/gqfdj1HbjXkbrht8dWuKUTv+J+qavZVhH7epOwzJS5BMJuW55vntHHoQmNIKo5Okygy5UDL/mE2NLjaA3zKjVdL3TZdEip4FKAiRQORS964Th4TT3bz6SApg8XtCc6jsnhQ7vB5/kzkPJn55rHma+1ScOoJVJeYgyipOXqLK2I+qwbBeCIYkiaVkdDiUeu29w7s94Tqf7mL9LspnMRqTvadAsXanbdnFWeMDRhYk+iLUPfYs1lzH7uZg+Hzxbpw2fOzOjuZegK1mCCJyaW0jxY6JiFcUVc7pHYGLh28dsj09Fk4JQ30K6wuXwbOf8sJRbXCOeg4ta2xgZk011G0jTF4AtT7MVkbwVfaYtX5s2pUHqriqYpmCOqQbpQl1c31Y8FU2Ee7oFKEoZx2Az5e/sHECvExhYwywCi5cBEY+a6skfOAqxjoYM29HXyMkHWoVx8IVu2lT03N9DE2t1oXBVx6xpehHs1/x2cAAu+LpgXy/7ORxD6MnY6hYfRcbEnE1d5xQP14+6Q2pRLn3EhCvVqSfwK4Vpv/U+/DOW0AeVytf2qM+g3HG7ljof+YxahjFQpMa0Z//SCNlXqjQsJ+Z3TtraBijxNkIN1VVPYCErJyfQw3PTL20frPOENj2gCwIkX2NefTUoAozQg92gkwKXGAdgvWcPVnmE/9h4Qg7snaoxOiRkCd3jp9iJjfKtqJr4i+2GHRtUJ0l8a2lmKDtQI1+2mQx1F0NotM7vXLKo24DiaQJsR2qr5cs2HTl1hVPV6/sAX0fc12sRfurcOCgOcusEk4F2KzsNGeUWM0DAQCWTLYLelAIs1Mnciz0M/G2fGEV9Utgbjcd2gO/8p4vdt5gTERUIbNNKNAWbaY6ZK+HXqdtcCXgi9Z8jXXCCfBz+DtmCdToNOBgG8XJ2/XhhCBSpVemf0TCSUkmPvAP1po130JO/JP1P0gDxMiIIfn/VbCqOqHaXIRf725UtK1tZ5M9mD12wDP2mzt14WpXiwHC45XZCzzQPPt828YceTQYsLU0N+B3xM9xM1EzgQj1uYo41Rdn7C8pVJfvcPCy2WDyJAg6CNgJ6pY1EbT7nB4p4z3UcCMA73BjTkgzoBX3KMHdln3I8bz8bHucGda4omev1w60ZFbmgoZIcvBSnU35td/waAtdah2pQaIs33lRRQ14/hY9JY3900yJKuGYvTKjpNvJCl7Fx8dnjp+OxhcfAlfCnzKj1P8Nvj+hypzjULU188nby8t07v59avszMEM3yqhBEluL04Yo9aAEaAE2qTFLXe/h2yKX5h61aFq6bBnnH/PA/XQWTDz8hwX3wyVZKWRcfnFCqlpg==]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
routeStatus 访客退出时,此路由的状态
trackRecordId 此次浏览轨迹的ID,浏览记录唯一值
visitPageCount 访客退出时此次浏览页面的数量
visitTotalTime 此次浏览页面访客的总浏览时长 单位:秒
chatRecordId 整个会话范围过程产生的人工对话的ID、机器人对话的ID、留言对话的ID 列表
giveupRecordId 整个会话范围过程中,访客点击对话,弹出信息收集框但访客最终未进入对话的,放弃的记录ID,记录ID是点击的ID,和对话记录留言记录的ID不是同一个数据
visitorOutTime 访客的离开的时间

3.4.3 轨迹数据
GET参数追加:dataType=visitorTrackPage
请求地址示例:

${URL}?timestamp=myTimestamp&nonce=myNonce&signature=81ceaac69a2f44be4f98d4adbea202d5792c62bb&dataType=visitorTrackPage
			

POST内容:对话评估的XML信息
明文XML示例:

<xml>
                <msgId><![CDATA[37122226]]></msgId>
                <tm><![CDATA[1563867929683]]></tm> 
       <trackData>
                <trackRecordId>17949</trackRecordId>
              <visitPageDatas>
                <pageData>
                  <visitTime><![CDATA[2018-01-31 10:51:34]]></visitTime>
                  <pageUrl><![CDATA[http://www.echatsoft.com]]></pageUrl>
                  <pageTitle><![CDATA[最近浏览]]></pageTitle>
                  <pageUrlAlias><![CDATA[页面别名]]</pageUrlAlias>
                </pageData>
                <pageData>
                  <visitTime><![CDATA[2018-01-31 10:51:36]]></visitTime>
                  <pageUrl><![CDATA[http://www.echatsoft.com]]></pageUrl>
                  <pageTitle><![CDATA[最近浏览]]></pageTitle>
                </pageData>
             </visitPageDatas>
       </trackData>
</xml>

密文XML示例:

<xml>
    <Encrypt><![CDATA[pcf0D1yQAvtOjRmwjkxHLuIjUFmA3AP+A2YKXxIerq5p/lh7URAmAXsxXJUJ4wu8kOkW/JGB9dyf7qmJYXMmv2TIyWSmDhhK1GXhZUHHBTyyWHieZaBUBPkT5EG3Vb/vX5amZE63vJllzyvDB9JD5MLoOyCS8O5JkPAWrVBGdFoa8VAEjEJHdSlDabyJ8h7QxX40z7002eAbZjwPtschrtVQjZd5j4U1e/NE5ryXq2jwljAC1WZHJb2F1K3nv+tKZuYQDltFxcE1LMA1m/b62allzqZ0ChYPsonSVcT7WtGLZAKqZktjO922qmsmfMeLBW4mO2Nw+D767W+9BUnucA==]]></Encrypt>
</xml>

XML属性解释

属性 含义
msgId 该条消息的唯一id
tm 时间戳
trackRecordId 此次浏览轨迹的ID,浏览记录唯一值
visitPageDatas 此次浏览的页面轨迹列表

pageData(浏览页面的信息)

属性 含义
visitTime 访问时间 格式:yyyy-MM-dd HH:mm:ss
pageUrl 访问页面的地址
pageTitle 访问页面的标题
pageUrlAlias 此页面的别名

4. demo代码下载

说明:可下载对应语言的demo工程,直接在项目上修改即可快速实现会员接入以及业务系统对接。
4.1 JAVA demo下载
下载地址:java demo