Wi-Fi設備管理
添加密碼型設備
調用此接口向指定門店添加密碼型設備的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頁面所需參數,該參數用于觸發(fā)呼起微信的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 }