字段名 | 含义 | 格式 | 是否需要开发者传入 |
---|---|---|---|
country | 国家 | 字符串 | 系统生成,不需要开发者传入 |
region | 省份 | 字符串 | 系统生成,不需要开发者传入 |
city | 城市 | 字符串 | 系统生成,不需要开发者传入 |
ip | ip | 字符串 | 系统生成,不需要开发者传入 |
isp | 运营商 | 字符串 | 系统生成,不需要开发者传入 |
device | 设备 | 字符串 | 系统生成,不需要开发者传入 |
os | 系统 | 字符串 | 系统生成,不需要开发者传入 |
referer_url | refer,从哪个网站跳转过来 | 字符串 | 系统生成,不需要开发者传入 |
referer_key | 来自搜索引擎的搜索key | 字符串 | 系统生成,不需要开发者传入 |
browser | 浏览器 | 字符串 | 系统生成,不需要开发者传入 |
from_channel | 渠道,例如微信 | 字符串 | 暂不生效 |
visit_count | 总访问次数 | 字符串 | 系统生成,不需要开发者传入 |
total_time | 总访问时间,单位毫秒 | 字符串 | 系统生成,不需要开发者传入 |
extra_ui | 自定义字段 | json串 | 开发者传入,千牛做展现 |
extra_param | 自定义字段 | 字符串 | 开发者传入,千牛做透传到插件 |
track | 浏览轨迹 | json串 | 如果用户端是iOS和Android,开发者传入,千牛做展现 如果是H5,系统生成,不需要开发者传入 |
itemid | 当前用户浏览着的宝贝id | 字符串 | 开发者传入,千牛做展现 |
extra_ui字段:
除了标准字段外,开发者可以使用自定义字段(KV集合),OpenIM完成数据从C端到B端展现的打通,千牛官方足迹插件会展现此类KV集合,展现如上图的(购买意向:高)
{"k1":"v1","k2":"v2",...}
extra_param字段:
除了标准字段外,开发者可以使用自定义param字段,OpenIM不做数据的展现,只是打通数据从C端到B端获取的通道,开发者可以使用该字段完成业务参数的传递
track字段:
用户在网站或者App的浏览轨迹集合,展现如上图,建议开发者在每个页面都做埋点
{ "referer_url":"www.baidu.com", "referer_keyword":"我是关键字", "title":"呢子衣服", //浏览轨迹title,iOS和Android需要开发者在用户端上传 "enter_time":"123", //浏览开始时间,单位毫秒 "url":"www.taobao.com/info?yifu" //浏览轨迹url,iOS和Android需要开发者在用户端上传 }
itemid字段:
C端用户当前正在浏览的宝贝id,OpenIM完成数据从C端到B端展现的打通,开发者在用户端上传这个字段,在客服端(千牛)可以通过这个宝贝id展现宝贝详细信息,展现如上图
具体见文档
通过继承TrackBaseActivity类,并调用如下代码完成浏览轨迹的提交。
YWTrackUtil.init(String userId, String appKey, IWxCallback callback);
初始化用户访问信息,使用足迹功能必须先调用该方法,否则会导致其他足迹接口调用失败。
setYWTrackTitleAndUrl(TAG, null); //浏览轨迹title和url
通过调用如下代码完成足迹自定义信息的提交。
YWTrackUtil.updateExtraInfo(String extra_ui, String extra_param, IWxCallback callback)
通过调用如下代码完成宝贝id的提交。
YWMessage message = YWMessageChannel.createGoodsFocusMessage("522211994009") YWConversationgetMessageSender().sendMessage(message,...)
通过调用如下代码完成交易id的提交。
YWMessage message = YWMessageChannel.createOrderFocusMessage("522211994009") YWConversationgetMessageSender().sendMessage(message,...)
具体见文档
通过调用如下代码完成浏览轨迹的提交。
conversationListController.ywcsDisplayName = @"会话列表"; //浏览轨迹title
通过调用如下代码完成足迹自定义信息的提交。
[YWExtensionServiceFromProtocol(IYWExtensionForCustomerService) updateExtraInfoWithExtraUI:@"{\"Key1\":\"Value1\"}" andExtraParam:@"透传内容" withCompletionBlock:nil];
通过调用如下代码完成宝贝id的提交。
[conversationViewController sendTradeItemMessage:@"123"];
通过调用如下代码完成订单id的提交。
[conversationViewController sendTradeInfoMessage:@"123"];
具体见文档
通过调用如下代码完成足迹自定义信息的提交。
在页面底部调用 WLOG.init({ uid: 'im90', // 当前页面用户名 appkey:'4272', // 应用appkey fromChannel:'', // 渠道(可选) dataForDisplay:{a:1}, // 自定义足迹(可选) extraData:{b:2} // 自定义参数(可选) });
通过调用如下代码完成宝贝id的提交。
WKIT.init({ container: document.getElementById('J_demo'), width: 700, height: 500, uid: 'ww1', appkey: 23015524, credential: '123456', touid: 'ww2', logo: 'http://img.alicdn.com/tps/i3/TB12LD9IFXXXXb3XpXXSyFWJXXX-82-82.png', pluginUrl: 'http://www.taobao.com/market/seller/openim/plugindemo.php', customData: { item: { id: 宝贝id //宝贝id } } });
通过调用如下代码完成订单id的提交。**需要kit版本0.2.8开始**
WKIT.init({ container: document.getElementById('J_demo'), width: 700, height: 500, uid: 'ww1', appkey: 23015524, credential: '123456', touid: 'ww2', logo: 'http://img.alicdn.com/tps/i3/TB12LD9IFXXXXb3XpXXSyFWJXXX-82-82.png', pluginUrl: 'http://www.taobao.com/market/seller/openim/plugindemo.php', customData: { order: { id: 订单id //订单id } } });
客服端(千牛)有足迹插件,开发者可以直接使用它,这样就不需要做B端集成。
如果开发者准备自己开发插件,可以使用如下接口,完成足迹信息的获取和展示。
获取足迹信息:
在B端插件中通过调用如下代码获取足迹信息,了解用户的来源,访问次数等,具体返回字段描述和展现可参考上图
QN.top.invoke({ cmd : 'taobao.openim.track.getsummary', param : {uid:'...' }, method : 'post', error : function(msg, cmd, param) {alert(JSON.stringify(msg));}, success : function(rsp, cmd, param) {$('#code-result').html(JSON.stringify(rsp));} }); rsp格式 { "openim_track_getsummary_response":{ "tracksummary":{ "region":"浙江省", "total_time":1000, "os":"win", "visit_count":2, "isp":"联通", "referer_url":"www.baidu.com", "extra_param":"...", "city":"杭州", "ip":"196.128.0.1", "country":"中国", "referer_keyword":"我是关键字", "from_channel":"微博", "device":"小米", "browser":"chrome", "extra_ui":{"购买意向":"高","用户颜色偏好":"白色系"} } } }
在B端插件中通过调用如下代码获取浏览轨迹,了解用户曾经的浏览页面,具体返回字段展现可参考上图
QN.top.invoke({ cmd : 'taobao.openim.track.getdetails', param : {uid:'...',starttime:'',endtime:'' },//时间访问范围可采用最近一个月 method : 'post', error : function(msg, cmd, param) {alert(JSON.stringify(msg));}, success : function(rsp, cmd, param) {$('#code-result').html(JSON.stringify(rsp));} }); rsp格式 { "openim_track_getdetails_response":{ "tracks":{ "tracks":[ { "referer_url":"www,baidu.com", "referer_keyword":"我是关键字", "title":"呢子衣服", //浏览轨迹title "enter_time":"1231", //浏览开始时间 "url":"www.taobao.com" //浏览轨迹url }, ... ] } } }
获取和设置用户备注:
在B端插件可以获取和设置用户备注,提升客服接待效率
获取用户备注 var reqJson = {uid:'iwangxinim11'}; QN.application.invoke({ cmd: 'getOpenIMRemark', param: reqJson, success: function (rsp) { alert(JSON.stringify(rsp)); }, error: function (msg) { alert(JSON.stringify(msg)); } }); }
设备用户备注 var reqJson = {uid:'iwangxinim11',remark:'good buyer'}; QN.application.invoke({ cmd: 'setOpenIMRemark', param: reqJson, success: function (rsp) { alert(JSON.stringify(rsp)); }, error: function (msg) { alert(JSON.stringify(msg)); } });
C端传输宝贝焦点和交易焦点见上面的章节。
交易焦点在足迹插件中的位置和宝贝焦点一样,优先显示交易焦点。
交易焦点属于Beta期,有任何问题欢迎联系我们。
B端获取宝贝焦点和交易焦点:
客服端(千牛)有足迹插件,开发者可以直接使用它,这样就只需要实现一个http服务,具体见宝贝定制和交易定制
如果开发者准备自己开发插件,可以使用如下接口,完成宝贝焦点和订单焦点的获取。
主动获取焦点id QN.wangwang.invoke({ cmd: 'getTradeFocus', param:{}, error: function (msg, cmd, param) { }, success: function (rsp, cmd, param) { $('#code-result').html(JSON.stringify(rsp));} }); rsp:{ "type":1,//宝贝焦点固定为1,交易焦点固定为0 "gids":[123,234,345] //焦点id集合,即C端传入的数据 }
注册宝贝焦点和订单焦点变化通知 用户在聊天过程中可能发生宝贝焦点和交易焦点变化,所以开发者需要监听这个方法 QN.event.regEvent({ eventId :'wangwang.trade_focus', success : function(eventId) {}, error : function(msg, eventId) {}, notify : function(data, eventId) {alert(JSON.stringify(data));} }); data:{ "user":"u1" "type":1,//宝贝焦点固定为1,交易焦点固定为0 "gids":[123,234,345] //焦点id集合 }
如果开发者要在后台调用足迹信息,做用户行为分析,可参考如下,同时千牛后续会出官方插件做行为统计:
用户足迹
用户浏览轨迹
宝贝焦点没有展现
1.打开足迹插件,摁下系统快捷键F12出现页面调试器。
2.调试器Console上看GetTradeFocus,如果失败(如上图),说明用户端(C端)没有正确的传递宝贝焦点ID。
3.调试器Console上看GetTradeFocus,如果成功,确定开发者后台是否有输入服务url和勾选getitemdetail,千牛在这个前提下才会去http访问开发者的url。
4.使用fiddler抓包确定开发者服务是否有被调用到,是否有返回如文档的response格式。
fiddler使用介绍:
1)打开fiddler,同时在千牛-系统设置-网络上设置如下图并保存,之后重新登陆千牛。
2)如果使用https,请在菜单tools-fiddler options上设置如下。