Wi-Fi store management
Get Wi-Fi store list
# Get WiFi through this interface Store list, which includes store information on the public platform and WiFi-related information after adding the device. For how to create a store, please refer to "WeChat store interface".
Note: The shop_id in all interfaces under WeChat connected to Wi-Fi must be obtained through this interface first.
Interface call description
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/shop/list?access_token=ACCESS_TOKENPOST 数据格式:JSON
Request parameter description
Parameter | Is it required | Description |
---|---|---|
access_token | Yes | Call interface credentials |
POST data | is | JSON data |
Field | Required | Description |
---|---|---|
pageindex | No | Page subscript, starting from 1 by default |
pagesize | No | Number of pages per page, default 10, maximum 20 |
Return data description
Correctly returned JSON data example:
{ "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": "" } ] } }
Field description:
Field | Description |
---|---|
totalcount | Total count |
pageindex | Page subscript |
pagecount | Page number |
records | Current page list array |
shop_id | Store ID |
shop_name | Store name |
ssid | The ssid of the wireless network device. If no device is added, it will be empty. If there are multiple ssids, the first one will be displayed |
ssid_list | SSID list of wireless network devices, return array format |
protocol_type | The device type of the device in the store, 0-no device added, 1 -Professional equipment, 4-password equipment, 5-portal self-service equipment, 31-portal transformation equipment |
sid | The merchant’s own ID, and the store Poi_id corresponding relationship, it is recommended to establish an association when adding a store. For details, please refer to "WeChat Store Interface" |
Query store Wi-Fi information
Query the detailed Wi-Fi information of a certain store through this interface, including the type of equipment in the store , ssid, password, number of devices, merchant homepage URL, and permanent entrance copy at the top.
Interface call description
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/shop/get?access_token=ACCESS_TOKEN POST数据格式:JSON
Request parameter description
Parameter | Is it necessary | Description |
---|---|---|
access_token | Yes | Call interface credentials |
POST data | is | JSON data |
POST data
Data example:
{ "shop_id": 429620 }
Field description:
Field | Is it required? | Description |
---|---|---|
pageindex | Page subscript, starting from 1 by default | No |
pagesize | Number of pages per page, default 10, maximum 20 | No |
Return data description
Correctly returned JSON data example:
{ "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 } }
Field description:
Field | Description |
---|---|
shop_name | Store name |
ssid | The ssid of the wireless network device. If no device is added, it will be empty. If there are multiple ssids, the first one will be displayed. |
ssid_list | Wireless SSID list of network devices, returns array format |
ssid_password_list | List of ssid and password, array format. When it is a password-type device, the password has the value |
password | . When the device type is password-type, it returns |
protocol_type | The device type of the device in the store, 0-no device added, 4-password device, 31-portal device |
ap_count | Total number of devices in the store |
template_id | Business homepage template type |
homepage_url | Business home page link |
bar_type | Text content displayed on the top permanent entrance: 0-- Welcome to the official account name; 1--Welcome to the store name; 2--Connected to the public account name WiFi; 3--Connected to the store name Wi-Fi |
finishpage_url | Network completion page link |
Modify store network information
Modify the store’s network information through this interface, including the network name (ssid) or password. Note:
1. This interface can be called to modify the network information only if the Wi-Fi network information has been added to the store; for the adding method, please refer to "Add Password Device" and "Add portal device" interface documentation.
2. After the network information is modified, password-type devices need to modify the SSIDs or passwords of all devices simultaneously; portal-type devices need to modify the SSIDs of all devices and follow the "Hardware Authentication Protocol Interface" 》Modify the ssid parameter in "Step 2: Transform the mobile portal page", otherwise you will not be able to connect to the Internet normally.
Interface call description
协议:https http请求方式: POST 请求URL: https://api.weixin.qq.com/bizwifi/shop/update?access_token=ACCESS_TOKEN 数据格式:JSON
Request parameter description
Parameter | Is it required | Description |
---|---|---|
access_token | Yes | Call interface credentials |
POST data | is | JSON data |
Field | Is it required? | Description |
---|---|---|
shop_id | Yes | Store ID |
old_ssid | is the ssid that | needs to be modified. When there are multiple ssids under the store, it is required |
ssid | is the ssid of the | wireless network device. Within 32 characters; SSID supports Chinese, but it may display garbled characters or be unable to connect due to device compatibility issues. You must bear the relevant risks at your own risk! When the store is a portal type device, the ssid is required; when the store is a password type device, the ssid is optional, and one of the ssid and password must start with the capital letter "WX" |
password | No | Password for the wireless network device. 8-24 characters; cannot contain Chinese characters; Password can only be filled in when the store has a password-based device, and one of the ssid and password must start with the capital letters "WX" |
Return data description
Correctly returned JSON data example:
{ "errcode": 0, }
##