微信html5頁面獲取設(shè)備信息

2019-03-14 12:00 更新

新增分組

html5

接口說明

新建設(shè)備分組,每個(gè)帳號(hào)下最多只有1000個(gè)分組。

接口調(diào)用說明

http請求方式: POST(請使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/group/add?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
  "group_name":"test"
}

參數(shù)說明

參數(shù)是否必須說明
access_token調(diào)用接口憑證
group_name分組名稱,不超過100漢字或200個(gè)英文字母   


返回說明

正常時(shí)的返回JSON數(shù)據(jù)包示例:

{
  "data": {
      "group_id" : 123,
      "group_name" : "test"
  },
  "errcode": 0,
  "errmsg": "success."
}

參數(shù)說明

參數(shù)說明
group_id 分組唯一標(biāo)識(shí),全局唯一
group_name分組名 

編輯分組信息

接口說明

編輯設(shè)備分組信息,目前只能修改分組名。

接口調(diào)用說明

http請求方式: POST(請使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/group/update?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
  "group_id":123,
  "group_name":"test update"
}

參數(shù)說明

參數(shù)是否必須說明
access_token調(diào)用接口憑證
group_id分組唯一標(biāo)識(shí),全局唯一
group_name分組名稱,不超過100漢字或200個(gè)英文字母


返回說明

正常時(shí)的返回JSON數(shù)據(jù)包示例:

{
  "data": {
  },
  "errcode": 0,
  "errmsg": "success."
}


刪除分組

接口說明

刪除設(shè)備分組,若分組中還存在設(shè)備,則不能刪除成功。需把設(shè)備移除以后,才能刪除。

接口調(diào)用說明

http請求方式: POST(請使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/group/delete?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
  "group_id":123
}

參數(shù)說明

參數(shù)是否必須說明
access_token調(diào)用接口憑證
group_id分組唯一標(biāo)識(shí),全局唯一   


返回說明

正常時(shí)的返回JSON數(shù)據(jù)包示例:

{
  "data": {
  },
  "errcode": 0,
  "errmsg": "success."
}


查詢分組列表

接口說明

查詢賬號(hào)下所有的分組。

接口調(diào)用說明

http請求方式: POST(請使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/group/getlist?    access_token=ACCESS_TOKEN
POST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
  "begin": 0,
  "count" 10
}

參數(shù)說明

參數(shù)是否必須說明
access_token調(diào)用接口憑證
begin分組列表的起始索引值
count待查詢的分組數(shù)量,不能超過1000個(gè)  


返回說明

正常時(shí)的返回JSON數(shù)據(jù)包示例:

{
  "data": {
  "total_count": 100,
      "groups":[
       {
          "group_id" : 123,
          "group_name" : "test1"
      },
      {
          "group_id" : 124,
          "group_name" : "test2"
      }
     ]
  },
  "errcode": 0,
  "errmsg": "success."
}

參數(shù)說明

參數(shù)說明 
total_count此賬號(hào)下現(xiàn)有的總分組數(shù)
groups分組列表
group_id分組唯一標(biāo)識(shí),全局唯一
group_name分組名

查詢分組詳情

接口說明

查詢分組詳情,包括分組名,分組id,分組里的設(shè)備列表。

接口調(diào)用說明

http請求方式: POST(請使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/group/getdetail?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
  "group_id":123
  "begin":0,
  "count":100
}

參數(shù)說明

參數(shù)是否必須說明
access_token調(diào)用接口憑證
group_id分組唯一標(biāo)識(shí),全局唯一
begin分組里設(shè)備的起始索引值
count待查詢的分組里設(shè)備的數(shù)量,不能超過1000個(gè)    


返回說明

正常時(shí)的返回JSON數(shù)據(jù)包示例:

{
  "data": {
      "group_id" : 123,
      "group_name" : "test",
      "total_count": 100,
      "devices" :[
          {
          "device_id" : 123456,
          "uuid" : "FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
          "major" : 10001,
          "minor" : 10001,
          "comment" : "test device1",
          "poi_id" : 12345,
          },
          {
          "device_id" : 123457,
          "uuid" : "FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
          "major" : 10001,
          "minor" : 10002,
          "comment" : "test device2",
          "poi_id" : 12345,
          }
          ]
      },
  "errcode": 0,
  "errmsg": "success."
}

參數(shù)說明

參數(shù)說明
group_id分組唯一標(biāo)識(shí),全局唯一
group_name分組名
total_count此分組現(xiàn)有的總設(shè)備數(shù)
devices分組下的設(shè)備列表
device_id設(shè)備編號(hào),設(shè)備全局唯一ID
uuid, major, minoruuid, major, minor
comment設(shè)備的備注信息
poi_id設(shè)備關(guān)聯(lián)的門店ID,關(guān)聯(lián)門店后,在門店1KM的范圍內(nèi)有優(yōu)先搖出信息的機(jī)會(huì)。門店相關(guān)信息具體可查看門店相關(guān)的接口文檔    

添加設(shè)備到分組

接口說明

添加設(shè)備到分組,每個(gè)分組能夠持有的設(shè)備上限為10000,并且每次添加操作的添加上限為1000。只有在搖周邊申請的設(shè)備才能添加到分組。

接口調(diào)用說明

http請求方式: POST(請使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/group/adddevice?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
  "group_id": 123,
  "device_identifiers":[
          {
          "device_id":10100,
          "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
          "major":10001,
          "minor":10002
          }
          ]
}

參數(shù)說明

參數(shù)是否必須說明
access_token調(diào)用接口憑證
device_identifiers設(shè)備id列表
device_id設(shè)備編號(hào),若填了UUID、major、minor,即可不填設(shè)備編號(hào),二者選其一
UUID、major、minorUUID、major、minor,三個(gè)信息需填寫完成,若填了設(shè)備編號(hào),即可不填此信息,二者選其一
group_id分組唯一標(biāo)識(shí),全局唯一

返回說明

正常時(shí)的返回JSON數(shù)據(jù)包示例:

{
  "data": {
  },
  "errcode": 0,
  "errmsg": "success."
}


從分組中移除設(shè)備

接口說明

從分組中移除設(shè)備,每次刪除操作的上限為1000。

接口調(diào)用說明

http請求方式: POST(請使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/group/deletedevice?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
 "group_id": 123,
  "device_identifiers":[
          {
          "device_id":10100,
          "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
          "major":10001,
          "minor":10002
          }
          ]
}

參數(shù)說明

參數(shù)是否必須說明
access_token調(diào)用接口憑證
device_identifiers設(shè)備id列表
device_id設(shè)備編號(hào),若填了UUID、major、minor,即可不填設(shè)備編號(hào),二者選其一
UUID、major、minorUUID、major、minor,三個(gè)信息需填寫完成,若填了設(shè)備編號(hào),即可不填此信息,二者選其一
group_id分組唯一標(biāo)識(shí),全局唯一 


返回說明

正常時(shí)的返回JSON數(shù)據(jù)包示例:

{
  "data": {
  },
  "errcode": 0,
  "errmsg": "success."
}


?H5頁面獲取設(shè)備信息 JS API

目錄

1 開啟查找周邊ibeacon設(shè)備接口

2 關(guān)閉查找周邊ibeacon設(shè)備接口

3 監(jiān)聽周邊ibeacon設(shè)備接口

 

接口說明

H5頁面獲取設(shè)備信息 JS API是為了擴(kuò)展搖周邊應(yīng)用的場景,讓開發(fā)者能夠在自己的H5應(yīng)用上通過接入微信JS-SDK,實(shí)現(xiàn)搜索周邊Beacon信號(hào)的一套api。在調(diào)用此接口之前,需要先把設(shè)備分組,微信客戶端只會(huì)返回已在分組中的設(shè)備信息,如何把設(shè)備分組,請查看上述分組相關(guān)的接口描述。

H5頁面獲取設(shè)備信息JSAPI包括startSearchBeacons、stopSearchBeacons、onSearchBeacons三個(gè)接口,只支持6.2.5以上的微信版本調(diào)用,需使用微信JS-SDK調(diào)用,且調(diào)用的公眾賬號(hào)需與創(chuàng)建分組的公眾賬號(hào)一致。在需要調(diào)用JS接口的頁面引入如下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.1.0.js,查看具體JS-SDK調(diào)用方法。

開啟查找周邊ibeacon設(shè)備接口

接口說明

查找周邊設(shè)備,目的是為有一定開發(fā)能力的商戶提供查找自己周邊設(shè)備的接口,在微信內(nèi)置瀏覽器中被訪問的網(wǎng)頁,可使用該JS代碼調(diào)起查找商家自己周邊的設(shè)備,方便商家利用此接口來檢查周邊是否存在自己的設(shè)備。 微信客戶端只要檢測到有信號(hào)的設(shè)備即返回設(shè)備信息,時(shí)間間隔為1S,android與iOS皆批量返回檢測到有信息的設(shè)備。

接口調(diào)用說明

示例:
wx.startSearchBeacons({
  ticket:"",
  complete:function(argv){
  //回調(diào)函數(shù)
  }
});

參數(shù)說明

參數(shù)是否必須說明
ticket搖周邊的業(yè)務(wù)ticket,系統(tǒng)自動(dòng)添加在搖出來的頁面鏈接后面           

返回說明

打開成功返回:“startSearchBeacons:ok”;

打開后未stop再次打開 :“startSearchBeacons:already started”;

藍(lán)牙未打開返回 :“startSearchBeacons:bluetooth power off”;

地理位置服務(wù)未打開返回: “startSearchBeacons:location service disable”;

系統(tǒng)不支持返回 :“startSearchBeacons:system unsupported”。

關(guān)閉查找周邊ibeacon設(shè)備接口

接口說明

關(guān)閉查找周邊設(shè)備。

接口調(diào)用說明

示例:
wx.stopSearchBeacons({
  complete:function(res){
  //回調(diào)函數(shù)
  }
});

返回說明

關(guān)閉成功返回“stopSearchBeacons:ok”;

監(jiān)聽周邊ibeacon設(shè)備接口

接口說明

監(jiān)聽周邊設(shè)備onSearchBeacons接口是在startSearchBeacons接口開啟后回調(diào)的,該接口返回該商家注冊的在周邊的相關(guān)設(shè)備。

接口調(diào)用說明

示例:
wx.onSearchBeacons({
  complete:function(argv){
  //回調(diào)函數(shù)
  }
});

返回說明

onSearchBeacons:
{
  "beacons":[
          {
          "major":10008,
          "minor":57686,
          "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
          "accuracy":"0.235344",
          "rssi":"-66",
          "proximity":"1",
          "heading":"288.1355"
          },
          {
          "major":10008,
          "minor":57687,
          "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
          "accuracy":"0.349124",
          "rssi":"-49",
          "proximity":"2",
          "heading":"288.1355"
          }
          ]
}

參數(shù)說明

參數(shù)說明
UUID、major、minorUUID、major、minor
accuracy距離,單位為米
proximity精度,0:CLProximityUnknown, 1:CLProximityImmediate, 2:CLProximityNear, 3:CLProximityFar
rssi接收信號(hào)的強(qiáng)度指示
heading接收信號(hào)時(shí)設(shè)備的方向(安卓設(shè)備返回有此字段,iOS無);iOS設(shè)備若需要獲取方向,可以利用HTML5標(biāo)準(zhǔn)API獲取,查看示例



以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)