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

微信小程序之Wi-Fi-小程序打通接口文档，微信小程序用户连Wi-Fi后长期逗留在场所内，可以在连接Wi-Fi后进入微信点击微信聊首页欢迎语，即可进入预先设置的小程序中获得资讯或服务，查询门店WiFi信息接口和连Wi-Fi完成页跳转小程序。

目录：

1、连Wi-Fi完成页跳小程序
2、商户主页跳转小程序
3、查询门店Wi-Fi信息接口

1、连Wi-Fi完成页跳转小程序

设置联网完成页接口

场景介绍：
设置需要跳转的小程序，连网完成点击“完成”按钮，即可进入设置的小程序。

注：只能跳转与公众号关联的小程序。

接口调用
接口调用说明

协议：https
请求方式: POST  
请求URL： https://api.weixin.qq.com/bizwifi/finishpage/set?access_token=ACCESS_TOKEN  
POST数据格式：JSON

请求参数说明

POST数据

数据示例：

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

字段说明

##2、设置顶部banner跳转小程序接口

场景介绍：

用户连Wi-Fi后长期逗留在场所内，可以在连接Wi-Fi后进入微信点击微信聊首页欢迎语，即可进入预先设置的小程序中获得资讯或服务。

注：只能跳转与公众号关联的小程序。

接口调用

接口调用说明

协议：https
请求方式: POST  
请求URL：https://api.weixin.qq.com/bizwifi/homepage/set?access_token=ACCESS_TOKEN  
POST数据格式：JSON

请求参数说明

POST数据

数据示例：

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

字段说明

3、查询门店WiFi信息接口

场景介绍

接口调用说明

协议：https  
http请求方式: POST  
请求URL：https://api.weixin.qq.com/bizwifi/shop/get?access_token=ACCESS_TOKEN  
POST数据格式：JSON

请求参数说明

POST数据

数据示例：

{  
  "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，传入密码发起连接。

该系列接口为系统原生能力，如需查看“微信连Wi-Fi”能力及配置跳转小程序，请参考文档。

连接指定 Wi-Fi 接口调用时序：

• Android： startWifi —> connectWifi —> onWifiConnected

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

连周边 Wi-Fi 接口调用时序：

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

• iOS（iOS 11.0及11.1版本因系统原因暂不支持）：
  startWifi —> getWifiList —> onGetWifiList —> setWifiList —> onWifiConnected

注意：

• Wi-Fi 相关接口暂不可用 wx.canIUse 接口判断。

• Android 6.0 以上版本，在没有打开定位开关的时候会导致设备不能正常获取周边的 Wi-Fi 信息。

wx.startWifi(OBJECT)

基础库 1.6.0 开始支持，低版本需做兼容处理

初始化 Wi-Fi 模块。

OBJECT参数说明：

示例代码：

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

wx.stopWifi(OBJECT)

基础库 1.6.0 开始支持，低版本需做兼容处理

关闭 Wi-Fi 模块。

OBJECT参数说明：

示例代码：

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

wx.connectWifi(OBJECT)

基础库 1.6.0 开始支持，低版本需做兼容处理

连接 Wi-Fi。若已知 Wi-Fi 信息，可以直接利用该接口连接。仅 Android 与 iOS 11 以上版本支持。

OBJECT参数说明：

示例代码：

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

wx.getWifiList(OBJECT)

基础库 1.6.0 开始支持，低版本需做兼容处理

请求获取 Wi-Fi 列表，在 onGetWifiList 注册的回调中返回 wifiList 数据。iOS 将跳转到系统的 Wi-Fi 界面，Android 不会跳转。 iOS 11.0 及 iOS 11.1 两个版本因系统问题，该方法失效。但在 iOS 11.2 中已修复。

OBJECT参数说明：

wx.onGetWifiList(CALLBACK)

基础库 1.6.0 开始支持，低版本需做兼容处理

监听在获取到 Wi-Fi 列表数据时的事件，在回调中将返回 wifiList。

CALLBACK 返回参数说明：

Wi-Fi 列表项说明：

wx.setWifiList(OBJECT)

基础库 1.6.0 开始支持，低版本需做兼容处理

iOS特有接口 在 onGetWifiList 回调后，利用接口设置 wifiList 中 AP 的相关信息。

注意：

1. 该接口只能在 onGetWifiList 回调之后才能调用。

2. 此时客户端会挂起，等待小程序设置 Wi-Fi 信息，请务必尽快调用该接口，若无数据请传入一个空数组。

3. 有可能随着周边 Wi-Fi 列表的刷新，单个流程内收到多次带有存在重复的 Wi-Fi 列表的回调。

OBJECT参数说明：

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)

基础库 1.6.0 开始支持，低版本需做兼容处理

监听连接上 Wi-Fi 的事件。

CALLBACK 返回参数说明：

wifi对象说明：

wx.getConnectedWifi(OBJECT)

基础库 1.6.0 开始支持，低版本需做兼容处理

获取已连接中的 Wi-Fi 信息

OBJECT参数说明：

success返回参数说明：

wifi对象说明：

errCode列表

每个接口调用的时候，都会返回 errCode 字段。