微信摇一摇周边 API

作者: magic_pill | 来源:发表于2018-01-16 21:24 被阅读573次

微信摇一摇周边 API
解密iBeacon物联网和火到爆的摇一摇
C#开发微信门户及应用(28)--微信“摇一摇·周边”功能的使用
小细节大体验-微信摇一摇
微信摇一摇场景使用
iBeacon-微信摇一摇周边
#订阅号摇红包功能视频演示#
微信摇奖盒为什么能有效提高商家的营销效果
微信摇一摇
朋友不在朋友圈

registerShakeAccount

申请开通功能
接口说明:
申请开通摇一摇周边功能。成功提交申请请求后，工作人员会在三个工作日内完成审核。若审核不通过，可以重新提交申请请求。
若是审核中，请耐心等待工作人员审核，在审核中状态不能再提交申请请求。
详情请参见：http://mp.weixin.qq.com/wiki/13/025f1d471dc999928340161c631c6635.html

Options:

{
 "name": "zhang_san",
 "phone_number": "13512345678",
 "email": "weixin123@qq.com",
 "industry_id": "0118",
 "qualification_cert_urls": [
   "http://shp.qpic.cn/wx_shake_bus/0/1428565236d03d864b7f43db9ce34df5f720509d0e/0",
   "http://shp.qpic.cn/wx_shake_bus/0/1428565236d03d864b7f43db9ce34df5f720509d0e/0"
 ],
 "apply_reason": "test"
}

Examples:

api.registerShakeAccount(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | registerShakeAccount |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

checkShakeAccountStatus

查询审核状态
接口说明：
查询已经提交的开通摇一摇周边功能申请的审核状态。在申请提交后，工作人员会在三个工作日内完成审核。
详情请参见：http://mp.weixin.qq.com/wiki/13/025f1d471dc999928340161c631c6635.html
Examples:

api.checkShakeAccountStatus(callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "data" : {
    "apply_time": 1432026025,
    "audit_comment": "test",
    "audit_status": 1,       //审核状态。0：审核未通过、1：审核中、2：审核已通过；审核会在三个工作日内完成
    "audit_time": 0
  },
  "errcode": 0,
  "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | checkShakeAccountStatus |
| 参数 | callback(Function) |

回调函数

applyBeacons

设备管理: 申请设备ID。
接口说明:
申请配置设备所需的UUID、Major、Minor。若激活率小于50%，不能新增设备。单次新增设备超过500个，
需走人工审核流程。审核通过后，可用返回的批次ID用“查询设备列表”接口拉取本次申请的设备ID。
详情请参见：http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

Options:

{
  "quantity":3,
  "apply_reason":"测试",
  "comment":"测试专用",
  "poi_id":1234
}

Examples:

api.applyBeacons(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | applyBeacons |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

applyBeaconsStatus

设备管理: 查询设备ID申请审核状态。
接口说明:
查询设备ID申请的审核状态。若单次申请的设备ID数量小于等于500个，系统会进行快速审核；
若单次申请的设备ID数量大于500个，则在三个工作日内完成审核。
详情请参见：http://mp.weixin.qq.com/wiki/10/9926857d34ef8cea6bcd6cffb6cea80a.html

Options:

{
  "apply_id": 12345
}

Examples:

api.applyBeaconsStatus(apply_id, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | applyBeaconsStatus |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

updateBeacon

设备管理: 编辑设备的备注信息。
接口说明:
可用设备ID或完整的UUID、Major、Minor指定设备，二者选其一。
详情请参见：http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html
Options:

{
 "device_identifier": {
   // 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
   "device_id": 10011,
   "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
   "major": 1002,
   "minor": 1223
 },
 "comment": "test"
}

Examples:

api.updateBeacon(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | updateBeacon |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

bindBeaconLocation

设备管理: 配置设备与门店的关联关系。
接口说明:
修改设备关联的门店ID、设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备，二者选其一。
详情请参见：http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html
Options:

{
  "device_identifier": {
    "device_id": 10011,
    "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
    "major": 1002,
    "minor": 1223
  },
  "poi_id": 1231
}

Examples:

api.bindBeaconLocation(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | bindBeaconLocation |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

getBeacons

设备管理: 查询设备列表
接口说明:
查询已有的设备ID、UUID、Major、Minor、激活状态、备注信息、关联门店、关联页面等信息。
可指定设备ID或完整的UUID、Major、Minor查询，也可批量拉取设备信息列表。
详情请参见：http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html
Options:

查询指定设备时：

{
 "device_identifier": [
   {
     "device_id":10011,
     "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
     "major":1002,
     "minor":1223
   }
 ]
}

需要分页查询或者指定范围内的设备时：

{
  "begin": 0,
  "count": 3
}

当需要根据批次ID查询时：

{
  "apply_id": 1231,
  "begin": 0,
  "count": 3
}

Examples:

api.getBeacons(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "data": {
    "devices": [
      {
        "comment": "",
        "device_id": 10097,
        "major": 10001,
        "minor": 12102,
        "page_ids": "15369",
        "status": 1, //激活状态，0：未激活，1：已激活（但不活跃），2：活跃
        "poi_id": 0,
        "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
      },
      {
        "comment": "",
        "device_id": 10098,
        "major": 10001,
        "minor": 12103,
        "page_ids": "15368",
        "status": 1,
        "poi_id": 0,
        "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
      }
     ],
     "total_count": 151
   },
   "errcode": 0,
   "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | getBeacons |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

createPage

页面管理: 新增页面
接口说明:
新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
其中，图片必须为用素材管理接口（uploadPageIcon函数）上传至微信侧服务器后返回的链接。
详情请参见：http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html
Page:

{
  "title":"主标题",
  "description":"副标题",
  "page_url":" https://zb.weixin.qq.com",
  "comment":"数据示例",
  "icon_url":"http://shp.qpic.cn/wx_shake_bus/0/14288351768a23d76e7636b56440172120529e8252/120"
  //调用uploadPageIcon函数获取到该URL
}

Examples:

api.createPage(page, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | createPage |
| 参数 | page(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

updatePage

页面管理: 编辑页面信息
接口说明:
编辑摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
详情请参见：http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html
Page:

{
  "page_id":12306,
  "title":"主标题",
  "description":"副标题",
  "page_url":" https://zb.weixin.qq.com",
  "comment":"数据示例",
  "icon_url":"http://shp.qpic.cn/wx_shake_bus/0/14288351768a23d76e7636b56440172120529e8252/120"
  //调用uploadPageIcon函数获取到该URL
}

Examples:

api.updatePage(page, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | updatePage |
| 参数 | page(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

deletePage

页面管理: 删除页面
接口说明:
删除已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
只有页面与设备没有关联关系时，才可被删除。
详情请参见：http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html
page_id:

{
  "page_id": 34567
}

Examples:

api.deletePage(page_id, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | deletePage |
| 参数 | page_id(Object) |

指定页面的id

|
| 参数 | callback(Function) |

回调函数

getPages

页面管理: 查询页面列表
接口说明:
查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。提供两种查询方式，可指定页面ID查询，也可批量拉取页面列表。
详情请参见：http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html
Options:

需要查询指定页面时：

{
  "page_ids":[12345, 23456, 34567]
}

需要分页查询或者指定范围内的页面时：

{
  "begin": 0,
  "count": 3
}

Examples:

api.getBeacons(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "data": {
    "pages": [
       {
         "comment": "just for test",
         "description": "test",
         "icon_url": "https://www.baidu.com/img/bd_logo1",
         "page_id": 28840,
         "page_url": "http://xw.qq.com/testapi1",
         "title": "测试1"
       },
       {
         "comment": "just for test",
         "description": "test",
         "icon_url": "https://www.baidu.com/img/bd_logo1",
         "page_id": 28842,
         "page_url": "http://xw.qq.com/testapi2",
         "title": "测试2"
       }
     ],
     "total_count": 2
   },
   "errcode": 0,
   "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | getPages |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

uploadPageIcon

上传图片素材
接口说明：
上传在摇一摇页面展示的图片素材，素材保存在微信侧服务器上。
格式限定为：jpg,jpeg,png,gif，图片大小建议120px*120 px，限制不超过200 px *200 px，图片需为正方形。
详情请参见：http://mp.weixin.qq.com/wiki/5/e997428269ff189d8f9a4b9e177be2d9.html
Examples:

api.uploadPageIcon('filepath', callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "data" : {
    "pic_url": "http://shp.qpic.cn/wechat_shakearound_pic/0/1428377032e9dd2797018cad79186e03e8c5aec8dc/120"
  },
  "errcode": 0,
  "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | uploadPageIcon |
| 参数 | filepath(String) |

文件路径

|
| 参数 | callback(Function) |

回调函数

bindBeaconWithPages

配置设备与页面的关联关系
接口说明:
配置设备与页面的关联关系。支持建立或解除关联关系，也支持新增页面或覆盖页面等操作。
配置完成后，在此设备的信号范围内，即可摇出关联的页面信息。若设备配置多个页面，则随机出现页面信息。
详情请参见：http://mp.weixin.qq.com/wiki/6/c449687e71510db19564f2d2d526b6ea.html
Options:

{
 "device_identifier": {
   // 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
   "device_id":10011,
   "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
   "major":1002,
   "minor":1223
 },
 "page_ids":[12345, 23456, 334567]
}

Examples:

api.bindBeaconWithPages(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | bindBeaconWithPages |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

searchBeaconPageRelation

查询设备与页面的关联关系
接口说明:
查询设备与页面的关联关系。提供两种查询方式，可指定页面ID分页查询该页面所关联的所有的设备信息；
也可根据设备ID或完整的UUID、Major、Minor查询该设备所关联的所有页面信息。
详情请参见：http://mp.weixin.qq.com/wiki/6/c449687e71510db19564f2d2d526b6ea.html
Options:

当查询指定设备所关联的页面时：

{
 "type": 1,
 "device_identifier": {
   // 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
   "device_id":10011,
   "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
   "major":1002,
   "minor":1223
 }
}

当查询页面所关联的设备时：
{
"type": 2,
"page_id": 11101,
"begin": 0,
"count": 3
}
Examples:

api.searchBeaconPageRelation(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
 "data": {
   "relations": [
     {
       "device_id": 797994,
       "major": 10001,
       "minor": 10023,
       "page_id": 50054,
       "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
     },
     {
       "device_id": 797994,
       "major": 10001,
       "minor": 10023,
       "page_id": 50055,
       "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
     }
   ],
   "total_count": 2
 },
 "errcode": 0,
 "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | searchBeaconPageRelation |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

getShakeInfo

获取摇周边的设备及用户信息
接口说明:
获取设备信息，包括UUID、major、minor，以及距离、openID等信息。
详情请参见：http://mp.weixin.qq.com/wiki/3/34904a5db3d0ec7bb5306335b8da1faf.html
Ticket:

{
  "ticket":”6ab3d8465166598a5f4e8c1b44f44645”
}

Examples:

api.getShakeInfo(ticket, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | getShakeInfo |
| 参数 | ticket(Object) |

摇周边业务的ticket，可在摇到的URL中得到，ticket生效时间为30分钟

|
| 参数 | callback(Function) |

回调函数

getDeviceStatistics

数据统计: 以设备为维度的数据统计接口
接口说明:
查询单个设备进行摇周边操作的人数、次数，点击摇周边消息的人数、次数；查询的最长时间跨度为30天。
详情请参见：http://mp.weixin.qq.com/wiki/0/8a24bcacad40fe7ee98d1573cb8a6764.html
Options:

{
  "device_identifier": {
    "device_id":10011,  //设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
    "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825", //UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息。
    "major":1002,
    "minor":1223
  },
  "begin_date": 12313123311,
  "end_date": 123123131231
}

Examples:

api.getDeviceStatistics(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "data" : {
    {
      "click_pv": 0,
      "click_uv": 0,
      "ftime": 1425052800,
      "shake_pv": 0,
      "shake_uv": 0
    },
    {
      "click_pv": 0,
      "click_uv": 0,
      "ftime": 1425139200,
      "shake_pv": 0,
      "shake_uv": 0
    }
  },
  "errcode": 0,
  "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | getDeviceStatistics |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

getDeviceStatisticsList

数据统计: 批量查询设备统计数据接口
接口说明:
查询指定时间商家帐号下的每个设备进行摇周边操作的人数、次数，点击摇周边消息的人数、次数。
只能查询最近90天内的数据，且一次只能查询一天。
此接口无法获取当天的数据，最早只能获取前一天的数据。由于系统在凌晨处理前一天的数据，
太早调用此接口可能获取不到数据，建议在早上8：00之后调用此接口。
注意：对于摇周边人数、摇周边次数、点击摇周边消息的人数、点击摇周边消息的次数都为0的设备，不在结果列表中返回。
详情请参见：http://mp.weixin.qq.com/wiki/1/e0b035c89b0a9c95a8210204087fec69.html
Options:

{
  date: 1438704000,
  page_index: 1
}

Examples:

api.getDeviceStatisticsList(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
"data": {
  "devices": [
    {
      "device_id": 10097,
      "major": 10001,
      "minor": 12102,
      "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
      "shake_pv": 1
      "shake_uv": 2
      "click_pv": 3
      "click_uv":4
    },
    {
      "device_id": 10097,
      "major": 10001,
      "minor": 12102,
      "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
      "shake_pv":1
      "shake_uv":2
      "click_pv":3
      "click_uv":4
    }
   ],
  },
  "date":1435075200
  "total_count": 151
  "page_index":1
  "errcode": 0,
  "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | getDeviceStatisticsList |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

getPageStatistics

数据统计: 以页面为维度的数据统计接口
接口说明:
查询单个页面通过摇周边摇出来的人数、次数，点击摇周边页面的人数、次数；查询的最长时间跨度为30天。
详情请参见：http://mp.weixin.qq.com/wiki/0/8a24bcacad40fe7ee98d1573cb8a6764.html
Options:

{
  "page_id": 12345,
  "begin_date": 12313123311,
  "end_date": 123123131231
}

Examples:

api.getPageStatistics(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "data" : {
    {
      "click_pv": 0,
      "click_uv": 0,
      "ftime": 1425052800,
      "shake_pv": 0,
      "shake_uv": 0
    },
    {
      "click_pv": 0,
      "click_uv": 0,
      "ftime": 1425139200,
      "shake_pv": 0,
      "shake_uv": 0
    }
  },
  "errcode": 0,
  "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | getPageStatistics |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

getPageStatisticsList

数据统计: 批量查询页面统计数据接口
接口说明:
查询指定时间商家帐号下的每个页面进行摇周边操作的人数、次数，点击摇周边消息的人数、次数。
只能查询最近90天内的数据，且一次只能查询一天。
此接口无法获取当天的数据，最早只能获取前一天的数据。由于系统在凌晨处理前一天的数据，
太早调用此接口可能获取不到数据，建议在早上8：00之后调用此接口。
注意：对于摇周边人数、摇周边次数、点击摇周边消息的人数、点击摇周边消息的次数都为0的设备，不在结果列表中返回。
详情请参见：http://mp.weixin.qq.com/wiki/1/e0b035c89b0a9c95a8210204087fec69.html
Options:

{
  date: 1425139200,
  page_index: 1
}

Examples:

api.getPageStatisticsList(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
"data": {
  "pages": [
    {
      "page_id": 1,
      "shake_pv": 1,
      "shake_uv": 2,
      "click_pv": 3,
      "click_uv":4
    },
    {
      "page_id": 2,
      "shake_pv":1,
      "shake_uv":2,
      "click_pv":3,
      "click_uv":4
    }
   ],
  },
  "date":1435075200
  "total_count": 151
  "page_index":1
  "errcode": 0,
  "errmsg": "success."
}

方法签名

| 方法 | make() |
| 名字 | getPageStatisticsList |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

listBeaconGroup

查询分组列表
接口说明：
查询账号下所有的分组。
options:
{
begin: 0,
count: 10
}
Examples:

api.listBeaconGroup(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | listBeaconGroup |
| 参数 | options(String) |

请求参数

|
| 参数 | callback(Function) |

回调函数

queryGroupBeacons

查询分组详情
接口说明：
查询分组详情，包括分组名，分组id，分组里的设备列表
options:
{
group_id: 123,
begin: 0,
count: 10
}
Examples:

api.queryGroupBeacons(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "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."
}

方法签名

| 方法 | make() |
| 名字 | queryGroupBeacons |
| 参数 | options(String) |

请求参数

|
| 参数 | callback(Function) |

回调函数

addBeaconGroup

新增分组
接口说明：
新建设备分组，每个帐号下最多只有100个分组。
group:
{
group_name: 'test'
}
Examples:

api.addBeaconGroup(group, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | addBeaconGroup |
| 参数 | group(Object) |

分组信息

|
| 参数 | callback(Function) |

回调函数

updateBeaconGroup

编辑分组信息
接口说明：
编辑设备分组信息，目前只能修改分组名。
group:
{
group_id: 123,
group_name: 'test update'
}
Examples:

api.updateBeaconGroup(group, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | updateBeaconGroup |
| 参数 | group(Object) |

分组信息

|
| 参数 | callback(Function) |

回调函数

deleteBeaconGroup

删除分组信息
接口说明：
删除设备分组，若分组中还存在设备，则不能删除成功。需把设备移除以后，才能删除。
group:
{
group_id: 123
}
Examples:

api.deleteBeaconGroup(group_id, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | deleteBeaconGroup |
| 参数 | group(Object) |

分组信息

|
| 参数 | callback(Function) |

回调函数

addGroupBeacons

添加设备到分组
接口说明：
添加设备到分组，每个分组能够持有的设备上限为10000，并且每次添加操作的添加上限为1000。只有在摇周边申请的设备才能添加到分组。
Options:

{
 "group_id": 123,
 "device_identifier": [
   {
     // 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
     "device_id": 10011,
     "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
     "major": 1002,
     "minor": 1223
   }
 ]
}

Examples:

api.addGroupBeacons(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | addGroupBeacons |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

deleteGroupBeacons

从分组中移除设备
接口说明：
从分组中移除设备，每次删除操作的上限为1000。
Options:

{
 "group_id": 123,
 "device_identifier": [
   {
     // 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
     "device_id": 10011,
     "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
     "major": 1002,
     "minor": 1223
   }
 ]
}

Examples:

api.deleteGroupBeacons(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

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

方法签名

| 方法 | make() |
| 名字 | deleteGroupBeacons |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

addLotteryInfo

创建红包活动
接口说明:
创建红包活动，设置红包活动有效期，红包活动开关等基本信息，返回活动id。
详情请参见：http://mp.weixin.qq.com/wiki/12/9738788d171724b080b52f6e41490cb4.html
Options:

{
  "use_template": 1,
  "logo_url": "https://lodejs.org/images/qr.jpg"
}

Body:

{
  "title": "抽奖活动名称",
  "desc": "抽奖活动描述",
  "onoff": 1,
  "begin_time": 1428854400,
  "expire_time": 1428940800,
  "sponsor_appid": "wx476f028272e53c62",
  "total": 10,
  "jump_url": "https://lodejs.org",
  "key": "u5pPq38tQP97yGn8iZxbBsfWvbn37poP"
}

Examples:

api.addLotteryInfo(options, body, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "errcode": 0,
  "errmsg": "",
  "lottery_id": "5794560",
  "page_id": 1,
}

方法签名

| 方法 | make() |
| 名字 | addLotteryInfo |
| 参数 | options(Object) |

请求参数

|
| 参数 | body(Object) |

JSON格式的结构体

|
| 参数 | callback(Function) |

回调函数

setPrizeBucket

录入红包信息
接口说明:
在调用"创建红包活动"接口之后，调用此接口录入红包信息。
详情请参见：http://mp.weixin.qq.com/wiki/12/9738788d171724b080b52f6e41490cb4.html
Options:

{
  "lottery_id": "5794560",
  "mchid": "1234567890",
  "sponsor_appid": "wx476f028272e53c62"
  "prize_info_list": [{
    "ticket": "v1|ZiPs2l0hpMBp3uwGI1rwp45vOdz/V/zQ/00jP9MeWT+e47/q1FJjwCIP34frSjzOxAEzJ7k2CtAg1pmcShvkChBWqbThxPm6MBuzceoHtj79iHuHaEn0WAO+j4sXnXnbGswFOlDYWg1ngvrRYnCY3g==",
  }]
}

Examples:

api.setPrizeBucket(options, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "errcode": 0,
  "errmsg": "",
  "success_num": 1,
  "repeat_ticket_list": [{
    "ticket": "v1|ZiPs2l0hpMBp3uwGI1rwp45vOdz/V/zQ/00jP9MeWT+e47/q1FJjwCIP34frSjzOxAEzJ7k2CtAg1pmcShvkChBWqbThxPm6MBuzceoHtj79iHuHaEn0WAO+j4sXnXnbGswFOlDYWg1ngvrRYnCY3g==",
  }]
}

方法签名

| 方法 | make() |
| 名字 | setPrizeBucket |
| 参数 | options(Object) |

请求参数

|
| 参数 | callback(Function) |

回调函数

setLotterySwitch

设置红包活动抽奖开关
接口说明:
开发者实时控制红包活动抽奖的开启和关闭。
详情请参见：http://mp.weixin.qq.com/wiki/12/9738788d171724b080b52f6e41490cb4.html
Examples:

api.setLotterySwitch(lotteryId, onoff, callback);

Callback:

err, 调用失败时得到的异常
result, 调用正常时得到的对象

Result:

{
  "errcode": 0,
  "errmsg": ""
}

方法签名

| 方法 | make() |
| 名字 | setLotterySwitch |
| 参数 | lotteryId(String) |

红包抽奖id

|
| 参数 | onoff(Number) |

活动抽奖开关，0：关闭，1：开启

|
| 参数 | callback(Function) |

回调函数

ge

微信摇一摇周边 API
registerShakeAccount 申请开通功能接口说明:申请开通摇一摇周边功能。成功提交申请请求后，工作人...
解密iBeacon物联网和火到爆的摇一摇
春晚的微信摇一摇抢红包，让摇一摇功能又火了一把。如今微信开放的摇一摇周边接口可能在未来的很多年会一直融入到我们的日...
C#开发微信门户及应用(28)--微信“摇一摇·周边”功能的使用
”摇一摇周边“是微信提供的一种新的基于位置的连接方式。用户通过“摇一摇”的“周边”页卡，可以与线下商户进行互动，获...
小细节大体验-微信摇一摇
微信摇一摇-性别为女时微信摇一摇-性别为男时
微信摇一摇场景使用
微信摇一摇·周边，是基于位置的连接方式，为更多线下商户提供便捷连接用户和精准近场服务的能力。商家首先需要配备摇一摇...
iBeacon-微信摇一摇周边
后台运行蓝牙服务http://www.tuicool.com/articles/n22ea2V iBeacon学习...
#订阅号摇红包功能视频演示#
视频中“颐高外滩国际”为认证订阅号并且开通了“微信摇一摇周边”功能，“乐摇互动”为开通微信支付的服务号，利用技术手...
微信摇奖盒为什么能有效提高商家的营销效果
理解微信摇奖盒概念的前提很多人用过微信的“摇一摇”功能，微信的这个“摇一摇”，可谓是神通广大。其中，“摇人”功能...
微信摇一摇
最近有做到摇一摇，发现还是很简单的，随手一记主要实现的功能是：开始要摇动的时候，图片会向两边分开，并且会...
朋友不在朋友圈
微信，是一个伟大的发明。记得从2013年开始玩微信，那时候的微信只是好奇里边的摇一摇和漂流瓶功能。那时候摇一摇能...

微信摇一摇周边 API

registerShakeAccount

checkShakeAccountStatus

applyBeacons

applyBeaconsStatus

updateBeacon

bindBeaconLocation

getBeacons

createPage

updatePage

deletePage

getPages

uploadPageIcon

bindBeaconWithPages

searchBeaconPageRelation

getShakeInfo

getDeviceStatistics

getDeviceStatisticsList

getPageStatistics

getPageStatisticsList

listBeaconGroup

queryGroupBeacons

addBeaconGroup

updateBeaconGroup

deleteBeaconGroup

addGroupBeacons

deleteGroupBeacons

addLotteryInfo

setPrizeBucket

setLotterySwitch

ge

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读