WeChat public platform developer documentation
/ Wi-Fi门店管理
Wi-Fi门店管理
获取Wi-Fi门店列表
通过此接口获取WiFi的门店列表,该列表包括公众平台的门店信息、以及添加设备后的WiFi相关信息。创建门店方法请参考“微信门店接口”。
注:微信连Wi-Fi下的所有接口中的shop_id,必需先通过此接口获取。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/shop/list?access_token=ACCESS_TOKENPOST 数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "pageindex": 1, "pagesize":2 }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
pageindex | 否 | 分页下标,默认从1开始 |
pagesize | 否 | 每页的个数,默认10个,最大20个 |
返回数据说明
正确返回JSON数据示例:
{ "errcode": 0, "data": { "totalcount": 16, "pageindex": 1, "pagecount": 8, "records": [ { "shop_id": 429620, "shop_name": "南山店", "ssid": "WX123", "ssid_list": [ "WX123", "WX456" ], "protocol_type": 4, "sid": "" }, { "shop_id": 7921527, "shop_name": "宝安店", "ssid": "", "ssid_list": [], "protocol_type": 0, "sid": "" } ] } }
字段说明:
字段 | 说明 |
---|---|
totalcount | 总数 |
pageindex | 分页下标 |
pagecount | 分页页数 |
records | 当前页列表数组 |
shop_id | 门店ID |
shop_name | 门店名称 |
ssid | 无线网络设备的ssid,未添加设备为空,多个ssid时显示第一个 |
ssid_list | 无线网络设备的ssid列表,返回数组格式 |
protocol_type | 门店内设备的设备类型,0-未添加设备,1-专业型设备,4-密码型设备,5-portal自助型设备,31-portal改造型设备 |
sid | 商户自己的id,与门店poi_id对应关系,建议在添加门店时候建立关联关系,具体请参考“微信门店接口” |
查询门店Wi-Fi信息
通过此接口查询某一门店的详细Wi-Fi信息,包括门店内的设备类型、ssid、密码、设备数量、商家主页URL、顶部常驻入口文案。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/shop/get?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "shop_id": 429620 }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
pageindex | 分页下标,默认从1开始 | 否 |
pagesize | 每页的个数,默认10个,最大20个 | 否 |
返回数据说明
正确返回JSON数据示例:
{ "errcode": 0, "data": { "shop_name": "南山店", "ssid": " WX123", "ssid_list": [ "WX123", "WX456" ], "ssid_password_list": [ { "ssid": "WX123", "password": "123456789" }, { "ssid": "WX456", "password": "21332465dge" } ], "password": "123456789", "protocol_type": 4, "ap_count": 2, "template_id": 1, "homepage_url": "http://www.weixin.qq.com/", "bar_type": 1 } }
字段说明:
字段 | 说明 |
---|---|
shop_name | 门店名称 |
ssid | 无线网络设备的ssid,未添加设备为空,多个ssid时显示第一个 |
ssid_list | 无线网络设备的ssid列表,返回数组格式 |
ssid_password_list | ssid和密码的列表,数组格式。当为密码型设备时,密码才有值 |
password | 设备密码,当设备类型为密码型时返回 |
protocol_type | 门店内设备的设备类型,0-未添加设备,4-密码型设备,31-portal型设备 |
ap_count | 门店内设备总数 |
template_id | 商家主页模板类型 |
homepage_url | 商家主页链接 |
bar_type | 顶部常驻入口上显示的文本内容:0--欢迎光临+公众号名称;1--欢迎光临+门店名称;2--已连接+公众号名称+WiFi;3--已连接+门店名称+Wi-Fi |
finishpage_url | 连网完成页链接 |
修改门店网络信息
通过此接口修改门店的网络信息,包括网络名称(ssid)或密码。需注意:
1. 只有门店下已添加Wi-Fi网络信息,才能调用此接口修改网络信息;添加方式请参考“添加密码型设备”和“添加portal型设备”接口文档。
2. 网络信息修改后,密码型设备需同步修改所有设备的ssid或密码;portal型设备需修改所有设备的ssid,并按照《硬件鉴权协议接口》修改“第二步:改造移动端portal页面”中的ssid参数,否则将无法正常连网。
接口调用说明
协议:https http请求方式: POST 请求URL: https://api.weixin.qq.com/bizwifi/shop/update?access_token=ACCESS_TOKEN 数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "shop_id": 429620, "old_ssid": "WX123", "ssid": "WX567" }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
shop_id | 是 | 门店ID |
old_ssid | 是 | 需要修改的ssid,当门店下有多个ssid时,必填 |
ssid | 是 | 无线网络设备的ssid。32个字符以内;ssid支持中文,但可能因设备兼容性问题导致显示乱码,或无法连接等问题,相关风险自行承担!当门店下是portal型设备时,ssid必填;当门店下是密码型设备时,ssid选填,且ssid和密码必须有一个以大写字母“WX”开头 |
password | 否 | 无线网络设备的密码。8-24个字符;不能包含中文字符;当门店下是密码型设备时,才可填写password,且ssid和密码必须有一个以大写字母“WX”开头 |
返回数据说明
正确返回JSON数据示例:
{ "errcode": 0, }