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" } }
欄位說明:
注意:
新增設備完成後,請務必依照鑑權協定介面進行裝置改造,否則無法實現微信連Wi-Fi。
#查詢裝置
可通过指定分页或具体门店ID的方式,查询当前MP账号下指定门店连网成功的设备信息。一次最多能查询20个门店的设备信息。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/device/list?access_token=ACCESS_TOKEN POST数据格式:JSON
請求參數說明
POST資料
資料範例:
分页查询时: { "pageindex": 1, "pagesize":10 } 根据门店ID查询时: { "pageindex": 1, "pagesize":10, "shop_id":429620 }
欄位說明:
#參數 | 是否必須 | |
---|---|---|
傳回資料說明
正確傳回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 } ] } }
欄位說明:
欄位 | 是否必填 | 說明 |
---|---|---|
pageindex | #否 | 分頁下標,預設從1開始 |
pagesize | 否 | 每頁的個數,預設10個,最大20個 |
刪除裝置
根據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 }