用户TAB页对接说明
七陌系统提供用户 TAB 页对接。七陌系统以 http get 方式调用第三方 B/S 系统的 url 。 如果是来电弹屏会将相关来电数据送给第三方系统。
注意:用户 TAB 页可以配置多个,url地址中如包含 # 请更换为%23
1.用户tab对接
用户tab对接后 通话、在线咨询(网站/WAP/H5/APP/公众号/小程序/微博/)、用户、工单 几个模块同时生效。
配置:在平台系统设置—>对接—>用户TAB对接
展示效果:用户tab对接后都是以tab页形式展现配置的url界面,如:
1.1 通话记录模块
a. 推送参数:
参数名 | 描述 |
tabType | call(通话记录模块固定为call) |
phone | 呼入通话为主叫号码,呼出为被叫号码 |
displayName | 处理坐席名称 |
exten | 处理坐席工号 |
callSheetId | 通话记录唯一标识 |
accountId | 账户编码,N+11位数字 |
【已存在用户会增加推送以下字段】 | |
name | 用户名称 |
title | 描述 |
status | 用户状态,用户模板中自定义的用户状态值 |
邮箱(如果配置多个邮箱会以","分割) | |
weixin | 微信(如果配置多个微信会以","分割) |
province | 省 |
city | 市 |
address | 用户地址 |
note | 备注 |
web | 网站(个人主页) |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
b.调用示例:
未保存用户【带token验证】:
https://www.baidu.com?tabType=call&phone=15318982011&displayName=zhangxiaojuan&exten=8000&callSheetId=507ea7ba-3509-4116-99fd-73e733694ea8&accountId=N00000022688[&token=35fa18357a8e021bf733bd0bf253a455&tokenId=46cb2060-e331-11e8-b583-9b5105e64a67]
已保存用户【带token验证】:
https://www.baidu.com?tabType=call&name=aaa&status=普通用户&title=&phone=13883303214&email=&weixin=&province=&city=&address=¬e=&web=&displayName=zhangxiaojuan&exten=8000&callSheetId=ffa7dad0-d473-4382-a39b-a98ae444ca62&accountId=N00000022688[&token=35fa18357a8e021bf733bd0bf253a455&tokenId=46cb2060-e331-11e8-b583-9b5105e64a67]
1.2 在线咨询模块
1.2.1 网站/WAP/H5
a. 推送参数:
参数名 | 描述 |
tabType | 在线客服模块固定为webchat |
qimoClientId | 会话用户id,初始化会话时系统随机生成的字符串,同一个用户用同一设备访问可能相同。 |
qimoClientName | 会话名称,如访客端上传了nickName则显示自定义的nickName,否则由系统随机生成一个字符串。 |
clientUserId | 访客端自定义用户id(userId),没有自定义则跟qimoClientId相同。 |
sessionId | 会话主键唯一标识 |
displayName | 处理坐席名称 |
exten | 处理坐席工号 |
accountId | 账户编码,N+11位数字 |
【待处理栏已存在用户会增加推送以下字段】 | |
name | 用户名称 |
title | 描述 |
status | 用户状态,用户模板中自定义的用户状态值 |
phone | 用户联系人电话(如果配置多个邮箱会以","分割) |
邮箱(如果配置多个邮箱会以","分割) | |
weixin | 微信(如果配置多个微信会以","分割) |
province | 省 |
city | 市 |
address | 用户地址 |
note | 备注 |
web | 网站(个人主页) |
【如果有上送扩展字段[访客端customField字段],则增加推送一以下字段】 | |
customField | 推送内容格式:{"参数名":"参数值",....} |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
b.调用示例
待处理栏已保存用户【带token验证】【扩展字段】:
https://www.baidu.com?tabType=webchat&name=嘎嘎嘎&status=普通用户&title=三四十&phone=132455&email=fasdfa&weixin=gfsdefasd&province=天津市&city=天津市&address=¬e=&web=&displayName=zhangxiaojuan&exten=8000&sessionId=86f1d1a0-e261-11e8-853a-dd00ffc3e2fb&qimoClientId=86ee2820-e261-11e8-b7f0-b36c93ee28ad&qimoClientName=mmkjjGK7FRY&clientUserId=86ee2820-e261-11e8-b7f0-b36c93ee28ad&accountId=N00000022688[&token=0b00b03e98b19df2b84433f7346e1cc5&tokenId=17509c40-e339-11e8-8ccf-6d0cce728d51][&customField={1111:2222,3333:4444}]
全部以及待处理栏未保存用户【带token验证】【扩展字段】:
https://www.baidu.com?tabType=webchat&qimoClientId=4db22e60-dcbe-11e8-a37c-b53b9516b824&qimoClientName=mmkjjM8xSnB&clientUserId=4db22e60-dcbe-11e8-a37c-b53b9516b824&displayName=zhangxiaojuan&exten=8000&sessionId=4db47850-dcbe-11e8-8996-2fa635d37cc3&accountId=N00000022688[&token=7fdf30101b75af14487fb6effd8c0432&tokenId=8313e400-e339-11e8-90b4-d76b694d8777][&customField={1111:2222,3333:4444}]
1.2.2 微信/小程序
a. 推送参数:
参数名 | 描述 |
tabType | 在线客服模块固定为webchat |
qimoClientId | 用户openId。 |
qimoClientName | 微信显示用户微信昵称,小程序里如果自定义了nickName则显示自定义nickName,否则为随机字符串。 |
clientUserId | 用户openId,跟qimoClientId相同。 |
sessionId | 会话主键唯一标识 |
displayName | 处理坐席名称 |
exten | 处理坐席工号 |
accountId | 账户编码,N+11位数字 |
【待处理栏已存在用户会增加推送以下字段】 | |
name | 用户名称 |
title | 描述 |
status | 用户状态,用户模板中自定义的用户状态值 |
phone | 用户联系人电话(如果配置多个邮箱会以","分割) |
邮箱(如果配置多个邮箱会以","分割) | |
weixin | 微信(如果配置多个微信会以","分割) |
province | 省 |
city | 市 |
address | 用户地址 |
note | 备注 |
web | 网站(个人主页) |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
b.调用示例:
待处理栏已存在用户[开启token验证]
http://www.baidu.com?tabType=webchat&name=测试小程序&status=二级用户&title=&phone=&email=&weixin=&province=&city=&address=¬e=&web=&displayName=6066&exten=6066&sessionId=94d835a0-cd2d-11e8-b110-a7385a67ce60&qimoClientId=oKHMM5NVpsLdUB_TKRWtR8HpSw5s&qimoClientName=hao.c.f&clientUserId=oKHMM5NVpsLdUB_TKRWtR8HpSw5s[&accountId=N00000003731&token=955ad084ddd825d547f5442f0f67f811&tokenId=c3d73520-e724-11e8-b4ac-3748c801029c]
待处理栏未保存用户以及全部栏[开启token验证]
http://www.baidu.com?tabType=webchat&qimoClientId=oznZKwI0o1A1ZDCuooNCVDD-WOJQ&qimoClientName=张小娟&clientUserId=oznZKwI0o1A1ZDCuooNCVDD-WOJQ&displayName=6066&exten=6066&sessionId=13cfef00-e3ff-11e8-ade1-d908fbc1896c&accountId=N00000003731[&token=9bc837e534da3a80be0755832ae7f08a&tokenId=326e8470-e725-11e8-a294-555e8a7ac387]
1.2.3 在线咨询-微博
a. 推送参数:
参数名 | 描述 |
tabType | 在线客服模块固定为webchat |
qimoClientId | 用户id,格式:微博用户id+'-'+公众微博id |
qimoClientName | 会话名称,微博用户昵称。 |
clientUserId | 访客端自定义用户id(userId),没有自定义则跟qimoClientId相同。 |
sessionId | 会话主键唯一标识 |
displayName | 处理坐席名称 |
exten | 处理坐席工号 |
accountId | 账户编码,N+11位数字 |
【待处理栏已存在用户会增加推送以下字段】 | |
name | 用户名称 |
title | 描述 |
status | 用户状态,用户模板中自定义的用户状态值 |
phone | 用户联系人电话(如果配置多个邮箱会以","分割) |
邮箱(如果配置多个邮箱会以","分割) | |
weixin | 微信(如果配置多个微信会以","分割) |
province | 省 |
city | 市 |
address | 用户地址 |
note | 备注 |
web | 网站(个人主页) |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
b.调用示例:
待处理栏已保存用户【开启token验证】:
http://www.baidu.com/#?tabType=webchat&name=888&;status=五级用户&title=jkjajflaf&phone=&email=&weixin=&province=辽宁省&city=本溪市&address=¬e=&web=&qimoClientId=6568601643-6069769720&qimoClientName=用户6568601643&clientUserId=6568601643-6069769720&displayName=6066&exten=6066&sessionId=f78b0160-e122-11e8-9be6-6b57963207aa&accountId=N00000003731&token=e5aaeb22daa6b914681061072581c812&tokenId=d0df9940-e6f9-11e8-910d-5fc570b5d8be
全部栏及待处理未保存用户【开启token验证】
http://www.baidu.com/#?tabType=webchat&qimoClientId=6428202884-6069769720&qimoClientName=寻觅99138&clientUserId=6428202884-6069769720&displayName=6066&exten=6066&sessionId=644616a0-e123-11e8-b8ff-15fd599d26c3&accountId=N00000003731&token=50aed636b89d4820ac150c85fc8f8f59&tokenId=c17c8040-e6f8-11e8-998a-3939d22d7265
1.2.4 APP
a. 推送参数:
参数名 | 描述 |
tabType | 在线客服模块固定为webchat |
qimoClientId | 会话id,格式:随机字符串@设备编号@自定义用户id@机型,同一个用户用同一设备访问可能相同。 |
qimoClientName | 会话名称,客端上传的nickName |
clientUserId | 访客端自定义用户id(userId) |
sessionId | 会话主键唯一标识 |
displayName | 处理坐席名称 |
exten | 处理坐席工号 |
accountId | 账户编码,N+11位数字 |
【已存在用户会增加推送以下字段】 | |
name | 用户名称 |
title | 描述 |
status | 用户状态,用户模板中自定义的用户状态值 |
phone | 用户联系人电话(如果配置多个邮箱会以","分割) |
邮箱(如果配置多个邮箱会以","分割) | |
weixin | 微信(如果配置多个微信会以","分割) |
province | 省 |
city | 市 |
address | 用户地址 |
note | 备注 |
web | 网站(个人主页) |
【如果有上送扩展字段[访客端customField字段],则增加推送一以下字段】 | |
customField | 推送内容格式:{"参数名":"参数值",....} |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
b.调用示例:
未保存用户【开启token验证】
http://www.baidu.com/#?tabType=webchat&name=888&status=五级用户&title=jkjajflaf&phone=&email=&weixin=&province=辽宁省&city=本溪市&address=¬e=&web=&displayName=6066&exten=6066&sessionId=d44d3770-c207-11e8-b1f8-3591612199a8&qimoClientId=6C30E4DB-ED7E-459D-B8A5-48174750900D@PkkUYs08@1246456568@iphone6s&qimoClientName=小测一下&clientUserId=1246456568&accountId=N00000003731&token=fbcbe1708c3b16281e4f47e1eb66c6b6&tokenId=c016cb30-e6f7-11e8-be29-1fac13f9ed24&customField={1111:2222,3333:4444}
已保存用户【开启token验证】
http://www.baidu.com/#?tabType=webchat&qimoClientId=A5AE22CB-1A30-4933-B576-1EFA619BC4FC@Yu3VQchs@432423423@iPhone6&qimoClientName=weqewqe&clientUserId=432423423&displayName=6066&exten=6066&sessionId=c5b9f460-e65f-11e8-96d3-83db105a9c8e&accountId=N00000003731&token=fbcbe1708c3b16281e4f47e1eb66c6b6&tokenId=c016cb30-e6f7-11e8-be29-1fac13f9ed24
1.3 用户模块
a. 推送参数:
参数名 | 描述 |
tabType | customer(用户模块固定为customer) |
displayName | 当前处理坐席名称 |
exten | 当前处理坐席工号 |
accountId | 账户编码,N+11位数字 |
【已存在用户会增加推送以下字段】 | |
name | 用户名称 |
title | 描述 |
status | 用户状态,用户模板中自定义的用户状态值 |
phone | 用户联系人电话号码,(如果配置多个会以","分割) |
邮箱(如果配置多个邮箱会以","分割) | |
weixin | 微信(如果配置多个微信会以","分割) |
province | 省 |
city | 市 |
address | 用户地址 |
note | 备注 |
web | 网站(个人主页) |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
b.调用示例:
http://www.baidu.com?tabType=customer&name=未知用户&status=普通用户&title=&phone=17301774090&email=&weixin=&province=上海市&city=上海市&address=&note=&web=&displayName=zhangxiaojuan&exten=8000&accountId=N00000022688&token=4f8b738ab93c617161a44e75b93a551f&tokenId=04bf8530-e7b4-11e8-aaa3-d76e40dd1c9e
1.4 工单模块
a. 推送参数:
参数名 | 描述 |
tabType | business(工单模块固定为business) |
displayName | 当前处理坐席名称 |
exten | 当前处理坐席工号 |
accountId | 账户编码,N+11位数字 |
【已存在用户会增加推送以下字段】 | |
name | 用户名称 |
title | 描述 |
status | 用户状态,用户模板中自定义的用户状态值 |
phone | 用户联系人电话号码,(如果配置多个会以","分割) |
邮箱(如果配置多个邮箱会以","分割) | |
weixin | 微信(如果配置多个微信会以","分割) |
province | 省 |
city | 市 |
address | 用户地址 |
note | 备注 |
web | 网站(个人主页) |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
b.调用示例:
已关联用户【开启token验证】
http://www.baidu.com?tabType=business&name=a&status=普通用户&title=sss&phone=15028289116&email=s&weixin=&province=&city=&address=&note=&web=&displayName=zhangxiaojuan&exten=8000&accountId=N00000022688&token=e1f2649fa8cbd2318e2f8080deaa8b42&tokenId=cb268630-e7d5-11e8-b272-3363847c98fc
未关联用户【开启token验证】
http://www.baidu.com?tabType=business&displayName=zhangxiaojuan&exten=8000&accountId=N00000022688&token=1815de6b925f9ce812c957f3d95508fb&tokenId=299eca10-e7d6-11e8-a294-555e8a7ac387
2.弹屏tab对接
2.1 来电弹屏
2.1.1 展示效果:以tab页形式展现配置好的tab列表
2.1.2 推送参数:
参数名 | 描述 |
originCallNo | 主叫号码 |
originCalledNo | 被叫号码 |
queue | 来单进入技能组编号 |
offeringTime | 来电进入系统的时间 |
callerProvince | 主叫号码省份 |
callerCity | 主叫号码城市 |
callSheetId | 通话记录的ID |
Agent/loginName | 接听座席工号 |
RingTime | 座席响铃时间,是时间戳格式 |
queueName | 来电进入技能组名称 |
ivrkey | 来电,在系统流转ivr时,按过的按键,每个按键以-分割 |
CallStatus | 接听状态:dealing(已接),notDeal(振铃未接听),leak(ivr放弃),queueLeak(排队放弃),blackList(黑名单),voicemail(留言) |
REPEAT_CALL | 是否是24小时内重复来电,是则推送“24h”,否则不推送任何值 |
shortTime | 呼叫时间,格式:hh:mm 24小时制 |
accountId | 账户编号 |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值 |
tokenId | 访问地址时携带tokenId的值 |
2.1.3 调用示例:
弹出方式:
https://www.baidu.com?originCallNo=13917553254&originCalledNo=02166604050&queue=10034094&offeringTime=2018-11-14%2016:51&callerProvince=%E9%87%8D%E5%BA%86%E5%B8%82&callerCity=%E9%87%8D%E5%BA%86%E5%B8%82&REPEAT_CALL=&callSheetId=33bc4675-4899-4024-9c1c-51d2bbaf3f75&Agent=8000&RingTime=1542185514.721246&CallStatus=leak&queueName=1&ivrkey=&shortTime=16:51&&loginName=8000&accountId=N00000022688&token=428b00cda6ac56c75a8c7dd422117e93&tokenId=896a78e0-e7ea-11e8-832c-976257bc33d6
嵌入方式:
https://www.baidu.com?originCallNo=13917553254&originCalledNo=02166604050&queue=10034094&offeringTime=2018-11-14 16:59&callerProvince=上海市&callerCity=上海市&REPEAT_CALL=&callSheetId=7be6d6d7-0fca-4255-b8d8-0a590fb651b5&Agent=8000&RingTime=1542185969.175301&CallStatus=leak&queueName=1&ivrkey=&shortTime=16:59&&loginName=8000&accountId=N00000022688&token=67259ac509af1c56b480c8626a2d4dd9&tokenId=984c2ce0-e7eb-11e8-aa8c-a5bbddb00104
2.2 外呼弹屏
2.2.1 展示效果:以弹屏形式展现配置的tab列表
2.2.2 推送参数:
参数名 | 描述 |
CallNo | 主叫号码,服务号或坐席手机号 |
CalledNo | 被叫号码 |
callSheetId | 通话记录的ID |
Agent/loginName | 接听座席工号 |
Ring | 座席响铃时间,是Linux时间戳格式 |
Province | 主叫号码归属地 省(直辖市),[弹出方式中文会被urlcode,嵌入方式为utf-8中文展示] |
District | 主叫号码归属地 市(直辖市所属县),[弹出方式中文会被urlcode,嵌入方式为utf-8中文展示] |
CallType | 呼叫类型,外呼固定为dialout |
CallID | 通话id |
accountId | 账户编号[嵌入方式推送,弹出方式不推送] |
【开启对接全局token验证功能后增加推送以下字段】 | |
token | 访问地址时携带token的值[嵌入方式正常,弹出方式值为undefined] |
tokenId | 访问地址时携带tokenId的值[嵌入方式正常,弹出方式值为undefined] |
2.2.3 调用示例:
弹出方式【开启token验证】:
https://www.baidu.com?CallNo=02166604050&CalledNo=13883303214&CallSheetID=8ac41d15-8f93-4e93-8b5b-5da9873b1543&CallType=dialout&Ring=1542185439.445182&Agent=8000&Province=%E9%87%8D%E5%BA%86%E5%B8%82&District=%E9%87%8D%E5%BA%86%E5%B8%82&CallID=cc-ali-0-1542185439.305925&loginName=8000&token=undefined&tokenId=undefined
嵌入方式【开启token验证】:
https://www.baidu.com?CallNo=02166604050&CalledNo=13917553254&CallSheetID=7c9aead9-cc3c-4553-9d90-7dcf76841fe8&CallType=dialout&Ring=1542185737.327286&Agent=8000&Province=上海市&District=上海市&CallID=cc-ali-0-1542185737.306065&loginName=8000&accountId=N00000022688&token=0edb414f2cf1404155850b4bf4593b60&tokenId=0e3698b0-e7eb-11e8-8e60-0deeafa10852
3. 对接全局token验证
在对接全局配置中开启token验证功能,开启之后会在访问页面的地址后加上两个参数 token tokenid,页面拿到这两个参数之后 可以通过我们提供的一个校验接口页面对接token校验 rest接口。详细接口使用可参考文档token校验