招乎功能接口(zhaohu)

描述

用于调用招乎sdk现有的功能,跳转到招乎相应的功能界面:订阅号会话、群组会话、我的关注列表、在线客服公众号等,查询招乎登录状态(6.3.0及以上版本支持)


调用方式

http://cmbls/zhaohufunc?id=xxx&&funcParam=xxx&allowMultiple=xxx&additionParam=xxx

参数

参数是否必选说明
id功能标识。
funcParam客户端透传传给招乎SDK,格式由招乎定义。
注:招乎给出的接口现只有一个参数,如有问题请联系万东栋
allowMultiple告知客户端需要多次回调(iPhone使用)。
注:如果没有该字段,默认只调用1次,值设成为true,支持多次回调网页(6.5.0以上版本支持)
additionParam

附加参数,预留


其中,funcParam的报文格式如下:
“{
   “func”:”newfeatures”,
   “entrance”:1,
   “params”:”exampleParams”
   }”


参数说明:

func: 用来区分不同的招乎功能页。目前取值包括:

取值
说明
newFeatures功能介绍
publicList订阅号列表
xiaoZhaoOnline小招在线
enterChat进入会话
chatList会话列表页
webBrowser招乎浏览器
followSubscription关注订阅号(手机银行客户端版本7.3或更高)



entrance: 用来标记功能调用来源,主要用来埋点,entrance不传值或传0表示无需埋点。可选值。目前常用定义如下:


Entrance
说明
1
从会话列表进入
2
订阅号详情
3
我的订阅号
4
通知栏
5
产品详情页的咨询入口
6
右上角咨询入口
7
从服务窗列表页进入
8
内顶部通知栏
9
历史消息记录
11
设置入口
12
订阅号名片页
13
广告位
14
理财频道
99
其他


params:各功能独有json格式,根据不同功能有不同的定义形式,如某功能无需传递独有JSON串,该值可省略。注意params对应的value也是JSON字符串。


实例





1.进入新功能介绍
{“func”:” newFeatures”,” entrance”:0}
2.进入订阅号列表
{“func”:” publicList”,” entrance”:0}
3.进入小招在线
场景带入进入小招在线
{“func”:” xiaoZhaoOnline”,” entrance”:0,” parmas”:”{“message”:” messagevalue”}”}
说明:
messagevalue为场景带入的json值,也需要作为一个JSON字符串。
4.发送图片消息给小招客服
{“func”:” xiaoZhaoOnline”,parmas:”{“image”:”0EAD562134/82FFD222A2B21C5”}”}
说明:
Iamge对应的value为base64编码的图片数据。
5.进入招乎会话
{“func”:” enterChat”,” entrance”:0,” parmas”:”{“chatID”:600**001 ,“message”:” messagevalue”}”}
说明:
chatID的value为对应的会话ID。不可省
mssagevalue:场景带入的json值,也需要作为一个JSON字符串。可省略
message为可选,如无需场景带入,该值可以省略。
6.进入会话列表页
{“func”:” chatList” }
7.招乎浏览器打开
{“func”:” webBrowser”,”parmas”:”{“url”:”http://zh.cmbchina.com”}”}
8.关注订阅号
{“func”: “followSubscription”,“params”:{“subscriptionID”: “6000001010002”,“shopName”: “订阅号名称”}}


返回调用接口

CMBLS.zhaohufunc.successCallback(id,message)

CMBLS.zhaohufunc.failCallback(id,message)


返回值


成功返回

<result>
  <statuscode>0</statuscode>
  <funcResponse>描述</funcResponse>//招乎跳转接口返回的信息
</result>


失败返回

<result>
  <statuscode>-1</statuscode>
  <errorMessage>描述</errorMessage>//招乎跳转接口返回的错误信息
 </result>


关注订阅号的返回码说明

返回码
说明
200
关注成功
300
用户拒绝关注
400
用户未登陆
500
请求订阅号信息失败
600
订阅号ID错误
700
用户选择关注却关注失败
800
用户已关注



调用实例

备注