微信小程序之Wi-Fi-小程序打通接口文檔

微信小程序之Wi-Fi-小程序打通接口文檔，微信小程序用戶連Wi-Fi后長期逗留在場所內(nèi)，可以在連接Wi-Fi后進(jìn)入微信點擊微信聊首頁歡迎語，即可進(jìn)入預(yù)先設(shè)置的小程序中獲得資訊或服務(wù)，查詢門店WiFi信息接口和連Wi-Fi完成頁跳轉(zhuǎn)小程序。

目錄：

1、連Wi-Fi完成頁跳小程序
2、商戶主頁跳轉(zhuǎn)小程序
3、查詢門店Wi-Fi信息接口

1、連Wi-Fi完成頁跳轉(zhuǎn)小程序

設(shè)置聯(lián)網(wǎng)完成頁接口

場景介紹：
設(shè)置需要跳轉(zhuǎn)的小程序，連網(wǎng)完成點擊“完成”按鈕，即可進(jìn)入設(shè)置的小程序。

注：只能跳轉(zhuǎn)與公眾號關(guān)聯(lián)的小程序。

接口調(diào)用
接口調(diào)用說明

協(xié)議：https
請求方式: POST  
請求URL： https://api.weixin.qq.com/bizwifi/finishpage/set?access_token=ACCESS_TOKEN  
POST數(shù)據(jù)格式：JSON

請求參數(shù)說明

POST數(shù)據(jù)

數(shù)據(jù)示例：

{
  "shop_id": 429620,
  "finishpage_url": "",  
  "wxa_user_name": "gh_966b66e00888",  
  "wxa_path": "pages/index/index",  
  "finishpage_type": 1  
}

字段說明

##2、設(shè)置頂部banner跳轉(zhuǎn)小程序接口

場景介紹：

用戶連Wi-Fi后長期逗留在場所內(nèi)，可以在連接Wi-Fi后進(jìn)入微信點擊微信聊首頁歡迎語，即可進(jìn)入預(yù)先設(shè)置的小程序中獲得資訊或服務(wù)。

注：只能跳轉(zhuǎn)與公眾號關(guān)聯(lián)的小程序。

接口調(diào)用

接口調(diào)用說明

協(xié)議：https
請求方式: POST  
請求URL：https://api.weixin.qq.com/bizwifi/homepage/set?access_token=ACCESS_TOKEN  
POST數(shù)據(jù)格式：JSON

請求參數(shù)說明

POST數(shù)據(jù)

數(shù)據(jù)示例：

{
    "shop_id": 2200766,  
    "template_id": 2,  
    "struct": {  
        "wxa_user_name": "gh_5cb1b4334f3a",  
        "wxa_path": "index.html?query=abc"  
    }
}

字段說明

3、查詢門店WiFi信息接口

場景介紹

接口調(diào)用說明

協(xié)議：https  
http請求方式: POST  
請求URL：https://api.weixin.qq.com/bizwifi/shop/get?access_token=ACCESS_TOKEN  
POST數(shù)據(jù)格式：JSON

請求參數(shù)說明

POST數(shù)據(jù)

數(shù)據(jù)示例：

{  
  "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,  
    "sid":"",  
    "poi_id":"285633617",  
    "homepage_wxa_user_name":"",  
    "homepage_wxa_path":"",  
    "finishpage_url":"",  
    "finishpage_wxa_user_name":"gh_966b66e00888",  
    "finishpage_wxa_path":"pages/index/index",  
    "finishpage_type":1,  
  }  
}

字段說明

在小程序中支持搜索周邊的 Wi-Fi，同時可以針對指定 Wi-Fi，傳入密碼發(fā)起連接。

該系列接口為系統(tǒng)原生能力，如需查看“微信連Wi-Fi”能力及配置跳轉(zhuǎn)小程序，請參考文檔。

連接指定 Wi-Fi 接口調(diào)用時序：

• Android： startWifi —> connectWifi —> onWifiConnected

• iOS（僅iOS 11及以上版本支持）：
  startWifi —> connectWifi —> onWifiConnected

連周邊 Wi-Fi 接口調(diào)用時序：

• Android startWifi —> getWifiList —> onGetWifiList —> connectWifi —> onWifiConnected

• iOS（iOS 11.0及11.1版本因系統(tǒng)原因暫不支持）：
  startWifi —> getWifiList —> onGetWifiList —> setWifiList —> onWifiConnected

注意：

• Wi-Fi 相關(guān)接口暫不可用 wx.canIUse 接口判斷。

• Android 6.0 以上版本，在沒有打開定位開關(guān)的時候會導(dǎo)致設(shè)備不能正常獲取周邊的 Wi-Fi 信息。

wx.startWifi(OBJECT)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

初始化 Wi-Fi 模塊。

OBJECT參數(shù)說明：

示例代碼：

wx.startWifi({
  success: function(res) { console.log(res.errMsg)
  }
})

wx.stopWifi(OBJECT)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

關(guān)閉 Wi-Fi 模塊。

OBJECT參數(shù)說明：

示例代碼：

wx.stopWifi({
  success: function(res) { console.log(res.errMsg)
  }
})

wx.connectWifi(OBJECT)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

連接 Wi-Fi。若已知 Wi-Fi 信息，可以直接利用該接口連接。僅 Android 與 iOS 11 以上版本支持。

OBJECT參數(shù)說明：

示例代碼：

wx.connectWifi({
  SSID: '',
  BSSID: '',
  success: function(res) { console.log(res.errMsg)
  }
})

wx.getWifiList(OBJECT)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

請求獲取 Wi-Fi 列表，在 onGetWifiList 注冊的回調(diào)中返回 wifiList 數(shù)據(jù)。iOS 將跳轉(zhuǎn)到系統(tǒng)的 Wi-Fi 界面，Android 不會跳轉(zhuǎn)。 iOS 11.0 及 iOS 11.1 兩個版本因系統(tǒng)問題，該方法失效。但在 iOS 11.2 中已修復(fù)。

OBJECT參數(shù)說明：

wx.onGetWifiList(CALLBACK)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

監(jiān)聽在獲取到 Wi-Fi 列表數(shù)據(jù)時的事件，在回調(diào)中將返回 wifiList。

CALLBACK 返回參數(shù)說明：

Wi-Fi 列表項說明：

wx.setWifiList(OBJECT)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

iOS特有接口 在 onGetWifiList 回調(diào)后，利用接口設(shè)置 wifiList 中 AP 的相關(guān)信息。

注意：

1. 該接口只能在 onGetWifiList 回調(diào)之后才能調(diào)用。

2. 此時客戶端會掛起，等待小程序設(shè)置 Wi-Fi 信息，請務(wù)必盡快調(diào)用該接口，若無數(shù)據(jù)請傳入一個空數(shù)組。

3. 有可能隨著周邊 Wi-Fi 列表的刷新，單個流程內(nèi)收到多次帶有存在重復(fù)的 Wi-Fi 列表的回調(diào)。

OBJECT參數(shù)說明：

Wi-Fi 信息列表項說明：

示例代碼：

wx.onGetWifiList({
  success: function(res) { if (res.wifiList.length) {
      wx.setWifiList({
        wifiList: [{
          SSID: res.wifiList[0].SSID,
          BSSID: res.wifiList[0].BSSID,
          password: '123456' }]
      })
    } else {
      wx.setWifiList({
        wifiList: []
      })
    }
  }
})
wx.getWifiList()

wx.onWifiConnected(CALLBACK)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

監(jiān)聽連接上 Wi-Fi 的事件。

CALLBACK 返回參數(shù)說明：

wifi對象說明：

wx.getConnectedWifi(OBJECT)

基礎(chǔ)庫 1.6.0 開始支持，低版本需做兼容處理

獲取已連接中的 Wi-Fi 信息

OBJECT參數(shù)說明：

success返回參數(shù)說明：

wifi對象說明：

errCode列表

每個接口調(diào)用的時候，都會返回 errCode 字段。