添加密码型设备
调用此接口向指定门店添加密码型设备的Wi-Fi信息。为保证门店下多台设备无缝漫游。
1. 同一个门店可以添加多个ssid,最大添加100个ssid;
2. 已添加过的ssid不能再重复添加;
3. 一个门店只能拥有一种设备类型,只要调用此接口添加一个ssid后,该门店即为密码型设备,不能再添加portal型设备。调用清空门店Wi-Fi信息接口清空网络信息后,可再设置为其它类型设备。
注意: 调用此接口后需要进行以下两步操作,才能正式启用设备
2. 请务必调用“获取物料二维码”接口,下载该门店二维码,张贴于店内。并确保有人(顾客或店员)用6.1以上安卓版微信或6.2.2以上ios版微信扫码连接Wi-Fi,连网成功即表示设备添加成功。
接口调用说明
协议:Https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/device/add?access_token=ACCESS_TOKEN POST数据格式:json
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "shop_id": 429620, "ssid": "WX123", "password": "12345689", }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
shop_id | 是 | 门店ID |
ssid | 是 | 无线网络设备的ssid。ssid和密码必须有一个以大写字母“WX”开头;32个字符以内;ssid支持中文,但可能因设备兼容性问题导致显示乱码,或无法连接等问题,相关风险自行承担! |
password | 是 | 无线网络设备的密码。8-24个字符;不能包含中文字符;ssid和密码必须有一个以大写字母“WX”开头 |
返回数据说明
正确返回JSON数据示例:
{ "errcode": 0 }
注意:添加设备完成后,请务必调用“获取物料二维码”接口,下载该门店二维码,张贴于店内。并确保有人(顾客或店员)用6.1以上安卓版微信或6.2.2以上IOS版微信扫码连接Wi-Fi,连网成功即表示设备添加成功。
添加portal型设备
调用下述接口可以添加portal型设备的网络信息,并获得secretkey。secretkey为加密字符串参数,是portal设备改造流程中的重要参数。为防止secretkey泄露,可通过此接口重置刷新,重置后之前生成的secretkey将会失效。需注意:
1. 同一个门店可以添加多个ssid,最大添加100个ssid;
2. 一个门店只能拥有一种设备类型,只要调用此接口添加一个ssid后,该门店即为portal型改造设备。如果门店下已有非portal型设备时,无法调用此接口。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/apportal/register?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "shop_id": 429620, "ssid": "WX123", "reset": false }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
shop_id | 是 | 门店ID |
ssid | 是 | 无线网络设备的ssid,限30个字符以内。ssid支持中文,但可能因设备兼容性问题导致显示乱码,或无法连接等问题,相关风险自行承担! |
reset | 否 | 重置secretkey,false-不重置,true-重置,默认为false |
返回数据说明
正确返回JSON数据示例:
{ "errcode": 0, "data": { "secretkey": "1af08ec5cdb70a4d7365bcd64d3120f6" } }
字段说明:
字段 | 说明 |
---|---|
secretkey | 改造portal页面所需参数,该参数用于触发呼起微信的JSAPI接口的sign参数值的计算 |
注意:
添加设备完成后,务必按照鉴权协议接口进行设备改造,否则无法实现微信连Wi-Fi。
查询设备
可通过指定分页或具体门店ID的方式,查询当前MP账号下指定门店连网成功的设备信息。一次最多能查询20个门店的设备信息。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/device/list?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
分页查询时: { "pageindex": 1, "pagesize":10 } 根据门店ID查询时: { "pageindex": 1, "pagesize":10, "shop_id":429620 }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
pageindex | 否 | 分页下标,默认从1开始 |
pagesize | 否 | 每页的个数,默认10个,最大20个 |
shop_id | 否 | 根据门店id查询 |
返回数据说明
正确返回JSON数据示例:
{ "errcode": 0, "data": { "totalcount": 2, "pageindex": 1, "pagecount": 1, "records": [ { "shop_id": 429620, "ssid": "WX123", "bssid": "00:1f:7a:ad:5b:a9", "protocol_type":4 }, { "shop_id": 429620, "ssid": "WX123", "bssid": "00:1f:7a:ad:5c:a8", "protocol_type":4 } ] } }
字段说明:
字段 | 说明 |
---|---|
totalcount | 总数 |
pageindex | 分页下标 |
pagecount | 分页页数 |
records | 当前页列表数组 |
shop_id | 门店ID |
ssid | 连网设备ssid |
bssid | 无线MAC地址 |
protocol_type | 门店内设备的设备类型,0-未添加设备,4-密码型设备,31-portal型设备 |
删除设备
根据bssid删除门店下的单个设备。删除后请尽快修改设备的网络名称和密码,或停止使用设备,否则设备会自动重新添加进来。如需清空门店网络及所有设备,请调用“清空门店网络及设备”接口。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/device/delete?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "bssid":"00:1f:7a:ad:5c:a8" }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
bssid | 是 | 需要删除的无线网络设备无线mac地址,格式冒号分隔,字符长度17个,并且字母小写,例如:00:1f:7a:ad:5c:a8 |
返回数据说明
正确返回JSON数据示例:
{ "errcode": 0 }