摇一摇关注的JSAPI
摇一摇关注JSAPI
接口说明
摇一摇关注JS API目的是为已开通微信摇一摇周边,且有一定开发能力的商户提供摇一摇关注能力。商户可以在摇出来的页面直接调用摇一摇关注接口,实现关注公众账号的功能。
注意事项:
1) 使用摇一摇关注时,不可诱导用户关注,一经查实,封号处罚;
2) 摇一摇关注仅在摇一摇·周边出来的H5页面才能正常运行。直接在微信浏览器中打开网页,此接口无法运行。开发人员调试的时候注意,必须走完整的摇周边流程,通过摇一摇进入页面测试。
3) 关注门店归属的公众账号,只支持在门店1公里范围内生效。
数据示例
关注JS API调用与微信的JS API调用格式一致,如下:
公用函数 | invoke |
用途 | 主动调用指定API |
通用形式 | BeaconAddContactJsBridge.invoke("API名称", {调用参数}, <回调函数>); |
注意:文档中所有代码只能在微信摇周边的场景下才能正确运行。直接在微信浏览器中打开网页,BeaconAddContactJsBridge不会正确运行。开发人员调试的时候注意,必须走完整的摇周边流程,通过摇一摇进入页面测试。
例子:
<!DOCTYPEhtml>
<htmllang="en">
<head>
<metacharset="UTF-8">
<title>开发者调用关注JS的example</title>
</head>
<body>
<h1>test</h1>
<scripttype="text/javascript"src="http://zb.weixin.qq.com/nearbycgi/addcontact/BeaconAddContactJsBridge.js">
</script>
<scripttype="text/javascript">
BeaconAddContactJsBridge.ready(function(){
//判断是否关注
BeaconAddContactJsBridge.invoke('checkAddContactStatus',{ type:0} ,function(apiResult){
if(apiResult.err_code == 0){
var status = apiResult.data;
if(status == 1){
alert('已关注');
}else{
alert('未关注');
//跳转到关注页
BeaconAddContactJsBridge.invoke('jumpAddContact',{ type:0});
}
}else{
alert(apiResult.err_msg)
}
});
});
</script>
</body>
</html>
引入BeaconAddContactJsBridge
<scripttype="text/javascript"src="http://zb.weixin.qq.com/nearbycgi/addcontact/BeaconAddContactJsBridge.js">
</script>
API详细说明
(一)判断是否关注checkAddContactStatus
a) 参数:传入{type:0}表示关注设备归属的公众账号,传入{ type:1}表示关注门店归属的公众账号。传入{ }默认为传入{type:0}。
b) 回调函数:function(apiResult){}
apiResult.err_code : 错误码,0代表正常返会,其他代表发生错误。
apiResult.err_msg : 错误详情,“ok”代表正常返回,其他代表具体的错误信息。
apiResult.data : 是否关注,1代表已经关注,0代表未关注。
例子:
BeaconAddContactJsBridge.invoke('checkAddContactStatus',{type:0} ,
function(apiResult){
if(apiResult.err_code == 0){
var status = apiResult.data;
if(status == 1){
alert('已关注');
}else{
alert('未关注'); }
}else{
alert(apiResult.err_msg)
}
});
(二)跳转到关注页jumpAddContact
a) 参数:传入{type:0}表示关注设备归属的公众账号,传入{ type:1}表示关注门店归属的公众账号。不传默认为传入{type:0}。
b) 回调函数:无。
例子:
BeaconAddContactJsBridge.invoke('jumpAddContact');