This API is used to add the Wi-Fi information of a password-based device to a specified store, so as to ensure seamless roaming between multiple devices in the store.

  1. A maximum of 100 SSIDs can be added to a store.

  2. An SSID can only be added once.

  3. A store can have only one device type. Once this API is called to add an SSID, the store's device type is password-based device, and no portal-based device can be added. When clearing the network information by calling the API for Clearing Store Network and Configuration, you can set a different type of device.

Note: After calling this API, you need to perform the following operations to enable the device:

1. Go to the wireless router console, modify the SSID and password of the device to be added to ensure that they are the same as those entered when calling the API.

  1. Be sure to call the API for Configuring Connection Method to download the store's QR code and post it in the store. Make sure that a customer or a clerk uses WeChat 6.1 or above for Android or WeChat 6.2.2 or above for iOS to connect to the Wi-Fi network. Successful connection means that the device is added successfully.

API Request Format

Protocol: HTTPS
HTTP request method: POST
Request URL: https://api.weixin.qq.com/bizwifi/device/add?access_token=ACCESS_TOKEN
POST data format: JSON

Request Parameters

Parameter Required Description
access_token Yes The credential for calling the API
POST data Yes JSON data

POST Data

Example:

{
  "shop_id": 429620,
  "ssid": "WX123",
  "password": "12345689",
}

Fields:

Field Required Description
shop_id Yes Store ID
ssid Yes The SSID of the wireless network device, with a maximum length of 32 characters. Either the SSID or the password must begin with "WX". Avoid using Chinese characters to prevent garbled characters or connection failures due to device compatibility issues.
password Yes The password for the wireless network device. It must be between 8-24 characters and cannot contain any Chinese characters. Either the SSID or the password must begin with "WX".

Response

The JSON data returned for a successful request:

{
  "errcode": 0
}

Note: After a device is added, call the API for Configuring Connection Method to download the store's QR code and post it in the store. Make sure that a customer or a clerk uses WeChat 6.1 or above for Android or WeChat 6.2.2 or above for iOS to connect to the Wi-Fi network. Successful connection means that the device is added successfully.