摇一摇周边接口文档

微信摇一摇周边使用文档

版本记录

日期 2015-4-9 2015-4-30 版本 V1.0版本 V1.1版本 初始版本; 更新点： 备注 1) 摇一摇关注无需邮件申请，满500个用户自动开通； 2) 增加门店接口文档的下载； 2015-6-11 V1.2版本 更新点： 1) 增加“申请开通摇一摇周边”接口 2) 增加“查询设备ID申请”接口； 3) “上传图片素材”接口增加图片类型； 4) 增加接口频率限制说明； 5) 增加错误码说明； 6) 增加摇一摇事件通知；

1

摇一摇周边接口文档

目录

1 2 2.1 2.1.1 2.1.2 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.3 2.3.1 2.3.2 2.3.3 2.3.4

前言 ............................................................................................................................ 4 接口说明 .................................................................................................................... 5 申请开通摇一摇周边 ................................................................................................ 5 申请开通功能 ........................................................................................................ 5 查询审核状态 ........................................................................................................ 7 设备管理 .................................................................................................................... 8 申请设备ID ........................................................................................................... 8 查询设备ID申请审核状态 ................................................................................ 12 编辑设备信息 ...................................................................................................... 14 配置设备与门店的关联关系 .............................................................................. 16 查询设备列表 ...................................................................................................... 18 页面管理 .................................................................................................................. 21 新增页面 .............................................................................................................. 21 编辑页面信息 ...................................................................................................... 23 查询页面列表 ...................................................................................................... 25 删除页面 .............................................................................................................. 28

2

摇一摇周边接口文档

2.4 2.4.1 2.5 2.6 2.7 2.7.1 2.7.2 2.8 2.9 2.9.1 3 4 5

素材管理 .................................................................................................................. 29 上传图片素材 ...................................................................................................... 29 配置设备与页面的关联关系 .................................................................................. 31 获取摇周边的设备及用户信息 .............................................................................. 33 数据统计 .................................................................................................................. 35 以设备为维度的数据统计接口 .......................................................................... 35 以页面为维度的数据统计接口 .......................................................................... 38 摇一摇关注JS API ................................................................................................. 41 事件通知 .................................................................................................................. 44 摇一摇事件通知 .................................................................................................. 44 接口频率限制说明 .................................................................................................. 46 错误码说明 .............................................................................................................. 48 联系我们 .................................................................................................................. 51

3

摇一摇周边接口文档

1 前言

摇一摇周边，是微信为线下商户提供的近距离连接用户的新玩法，支持线下商户向周边用户提供个性化信息、互动及服务等。

在手机蓝牙打开的状态下，当用户在微信中打开摇一摇，如果处于iBeacon设备的信号范围内，会自动出现“周边”页卡，此时用户摇一摇就会获得周边商户所配置的信息。 商户在使用摇一摇周边接口时，需先申请摇一摇周边功能，申请审核通过后，才能正常调用接口。

4

摇一摇周边接口文档

2 接口说明

2.1 申请开通摇一摇周边

2.1.1 申请开通功能

? 接口说明

申请开通摇一摇周边功能。成功提交申请请求后，工作人员会在三个工作日内完成审核。若审核不通过，可以重新提交申请请求。若是审核中，请耐心等待工作人员审核，在审核中状态不能再提交申请请求。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/account/register?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例

5

摇一摇周边接口文档

{ \ \ \ \ \ \ \ ], \}

字段说明

字段 name phone_number email 联系人姓名 联系人电话 联系人邮箱 平台定义的行业代号，具体请查看链接industry_id http://3gimg.qq.com/shake_nearby/Qualificationdocuments.html 相关资质文件的图片url，图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传是 图片，返回的图片URL再配置在此处； 当不需要资质文件时，数组内可以不填写url apply_reason 申请理由 否 是 说明 是否必填 是 是 是 qualification_cert_urls 6

摇一摇周边接口文档

? 返回数据说明

正确返回JSON数据示例：

{ \ }, \ \}

2.1.2 查询审核状态

? 接口说明

查询已经提交的开通摇一摇周边功能申请的审核状态。在申请提交后，工作人员会在三个工作日内完成审核。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/account/auditstatus?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 否 7

说明 调用接口凭证 JSON数据 摇一摇周边接口文档

? 返回数据说明

正确返回JSON数据示例：

{ \ \ \ \ \ }, \ \}

字段说明

字段 apply_time 提交申请的时间戳 审核状态。0：审核未通过、1：审核中、2：审核已通过； audit_status 审核会在三个工作日内完成 audit_comment audit_time 审核备注，包括审核不通过的原因 确定审核结果的时间戳；若状态为审核中，则该时间值为0 说明 2.2 设备管理

2.2.1 申请设备ID

? 接口说明

申请配置设备所需的UUID、Major、Minor。

申请成功后返回批次ID，可用返回的批次ID通过“查询设备ID申请状态”接口查询

8

摇一摇周边接口文档

目前申请的审核状态。若单次申请的设备ID数量小于等于500个，系统会进行快速审核；若单次申请的设备ID数量大于500个，会在三个工作日内完成审核，审核状态可通过接口“查询设备申请审核状态”进行查询。如果已审核通过，可用返回的批次ID通过“查询设备列表”接口拉取本次申请的设备ID。

一个公众账号最多可申请99999个设备ID，如需申请的设备ID数超过最大限额，请邮件至zhoubian@tencent.com，邮件格式如下：

标题：申请提升设备ID额度

内容：1、公众账号名称及appid（wx开头的字符串，在mp平台可查看）

2、用途

3、预估需要多少设备ID

通过接口申请的设备ID，请先直接配置页面，若未配置页面，则摇不出页面信息。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/device/applyid?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 9

摇一摇周边接口文档

? POST数据

数据示例

{ \ \测试\ \测试专用\\ }

字段说明

字段 说明 申请的设备ID的数量，单次新增设备超过500个，quantity 需走人工审核流程 apply_reason comment 申请理由，不超过100个字 备注，不超过15个汉字或30个英文字母 设备关联的门店ID，关联门店后，在门店1KM的范poi_id 围内有优先摇出信息的机会。门店相关信息具体可查看门店相关的接口文档 否 是 否 是 是否必填 ? 返回数据说明

正确返回JSON数据示例：

10

摇一摇周边接口文档 当申请个数小于等于500时， { \\ \ { \ \ \ \ } ] }, \ \} 当申请个数大于500时， { \\ \ \审核未通过\ }, \ \} 字段说明

字段 device_identifiers device_id 指定的设备ID列表 设备编号 说明 UUID、major、minor UUID、major、minor 11

摇一摇周边接口文档 审核状态。0：审核未通过、1：审核中、2：审核已通过； audit_status 审核会在三个工作日内完成 audit_comment 审核备注，包括审核不通过的原因 申请的批次ID，可用在“查询设备列表”接口按批次查询本次申请apply_id 成功的设备ID。 2.2.2 查询设备ID申请审核状态

? 接口说明

查询设备ID申请的审核状态。若单次申请的设备ID数量小于等于500个，系统会进行快速审核；若单次申请的设备ID数量大于500个，则在三个工作日内完成审核。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/device/applystatus?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

12

摇一摇周边接口文档

数据示例

{ \}

字段说明

字段 apply_id 说明 批次ID，申请设备ID时所返回的批次ID 是否必填 是 ? 返回数据说明

正确返回JSON数据示例：

{ \ \ \ \ \ }, \ \}

字段 apply_time 提交申请的时间戳 审核状态。0：审核未通过、1：审核中、2：审核已通过； audit_status 审核会在三个工作日内完成 audit_comment audit_time 审核备注，包括审核不通过的原因 确定审核结果的时间戳，若状态为审核中，则该时间值为0 说明 13

摇一摇周边接口文档

2.2.3 编辑设备信息

? 接口说明

编辑设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备，二者选其一。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/device/update?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例

14

摇一摇周边接口文档

{ \ \ \ \ \ }, \“test” }

字段说明

字段 device_identifier 指定的设备ID 设备编号，若填了UUID、major、minor，则可不device_id 填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor，三个信息需填写完整，若UUID、major、minor 填了设备编号，则可不填此信息 设备的备注信息，不超过15个汉字或30个英文字comment 母 是 是 是 说明 是否必填 是 ? 返回数据说明

正确返回JSON数据示例：

{ \ }, \ \} 15

摇一摇周边接口文档

2.2.4 配置设备与门店的关联关系

? 接口说明

修改设备关联的门店ID、设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备，二者选其一。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/device/bindlocation?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例

16

摇一摇周边接口文档

{ \ \ \ \ \ }, \ }

字段说明

字段 device_identifier 指定的设备ID 设备编号，若填了UUID、major、minor，则可不device_id 填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor，三个信息需填写完整，若UUID、major、minor 填了设备编号，则可不填此信息 设备关联的门店ID，关联门店后，在门店1KM的范poi_id 围内有优先摇出信息的机会。门店相关信息具体可查看门店相关的接口文档 是 是 是 说明 是否必填 是 ? 返回数据说明

正确返回JSON数据示例：

17

摇一摇周边接口文档 { \ }, \ \} 2.2.5 查询设备列表

? 接口说明

查询已有的设备ID、UUID、Major、Minor、激活状态、备注信息、关联门店、关联页面等信息。可指定设备ID或完整的UUID、Major、Minor查询，也可批量拉取设备信息列表。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/device/search?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

18

摇一摇周边接口文档

数据示例

查询指定设备时： { \ { \ \ \ \ } ] } 需要分页查询或者指定范围内的设备时： { \ \} 当需要根据批次ID查询时： { \ \ \} 字段说明

字段 device_identifiers 指定的设备 设备编号，若填了UUID、major、minor，则可不device_id 填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor UUID、major、minor，三个信息需填写完整，若19

说明 是否必填 是 是 是 摇一摇周边接口文档 填了设备编号，则可不填此信息 apply_id begin count 批次ID，申请设备ID时所返回的批次ID 设备列表的起始索引值 待查询的设备个数 是 是 是 ? 返回数据说明

正确返回JSON数据示例：

{ \ \ { \ \ \ \ \ \ \ \ }, { \ \ \ \ \ \ \ \ } ], \ }, \ \} 20

摇一摇周边接口文档

字段说明

字段 devices device_id 指定的设备信息列表 设备编号 说明

UUID、major、minor UUID、major、minor status 激活状态，0：未激活，1：已激活（但不活跃），2：活跃 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇poi_id 出信息的机会。门店相关信息具体可查看门店相关的接口文档 comment page_ids total_count 设备的备注信息 与此设备关联的页面ID列表，用逗号隔开 商户名下的设备总量 2.3 页面管理

2.3.1 新增页面

? 接口说明

新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。其中，图片必须为用素材管理接口上传至微信侧服务器后返回的链接。

? 接口调用说明

协议 http请求方式 请求URL

https POST https://api.weixin.qq.com/shakearound/page/add?access_token=21

摇一摇周边接口文档 ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例 { \主标题\ \副标题\ \ \数据示例\ \} 字段说明

字段 title description 说明 在摇一摇页面展示的主标题，不超过6个字 在摇一摇页面展示的副标题，不超过7个字 在摇一摇页面展示的图片。图片需先上传至微信侧服icon_url 务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处 page_url comment

是否必填 是 是 是 跳转链接 页面的备注信息，不超过15个字 22

是 否 摇一摇周边接口文档

? 返回数据说明

正确返回JSON数据示例：

{ \ \ } \ \}

字段说明

字段 page_id 新增页面的页面id 说明 2.3.2 编辑页面信息

? 接口说明

编辑摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。

? 接口调用说明

协议 http请求方式 https POST https://api.weixin.qq.com/shakearound/page/update?access_toke请求URL n=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

23

摇一摇周边接口文档 参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例 { “page_id”:12306 \主标题\ \副标题\ \ \数据示例\ \} 字段说明

字段 page_id title description 摇周边页面唯一ID 在摇一摇页面展示的主标题，不超过6个字 在摇一摇页面展示的副标题，不超过7个字 在摇一摇页面展示的图片。图片需先上传至微信侧服icon_url 务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处 page_url comment 跳转链接 页面的备注信息，不超过15个字 是 否 是 说明 是否必填 是 是 是 ? 返回数据说明

24

摇一摇周边接口文档

正确返回JSON数据示例：

{ \ \ }, \ \} 字段说明

字段 page_id 编辑页面的页面ID 说明

2.3.3 查询页面列表

? 接口说明

查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。提供两种查询方式，可指定页面ID查询，也可批量拉取页面列表。

? 接口调用说明

协议 http请求方式 https POST https://api.weixin.qq.com/shakearound/page/search?access_toke请求URL n=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 是否必须 25

说明

摇一摇周边接口文档 access_token POST数据 是 是 调用接口凭证 JSON数据 ? POST数据

数据示例

需要查询指定页面时： { \} 需要分页查询或者指定范围内的页面时： { \ \} 字段说明

字段 page_ids begin count 指定页面的id列表 页面列表的起始索引值 待查询的页面个数 说明 是否必填 是 是 是 ? 返回数据说明

正确返回JSON数据示例：

26

摇一摇周边接口文档

{ \ \ { \ \ \ \ \ \测试1\ }, { \ \ \ \ \ \测试2\ } ], \ }, \ \}

字段说明

字段 total_count page_id title description icon_url page_url

说明 商户名下的页面总数 摇周边页面唯一ID 在摇一摇页面展示的主标题， 在摇一摇页面展示的副标题， 在摇一摇页面展示的图片 跳转链接 27 摇一摇周边接口文档 comment 页面的备注信息 2.3.4 删除页面

? 接口说明

删除已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。只有页面与设备没有关联关系时，才可被删除。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/page/delete?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例

{ \} 28

摇一摇周边接口文档

字段说明

字段 page_ids 指定页面的id列表 说明 是否必填 是

? 返回数据说明

正确返回JSON数据示例：

{ \ }, \ \} 2.4 素材管理

2.4.1 上传图片素材

? 接口说明

上传在摇一摇功能中需使用到的图片素材，素材保存在微信侧服务器上。图片格式限定为：jpg,jpeg,png,gif。

若图片为在摇一摇页面展示的图片，则其素材为icon类型的图片，图片大小建议120px*120 px，限制不超过200 px *200 px，图片需为正方形。

若图片为申请开通摇一摇周边功能需要上传的资质文件图片，则其素材为license类型的图片，图片的文件大小不超过2MB，尺寸不限，形状不限。

? 接口调用说明

协议

https 29 摇一摇周边接口文档 http请求方式 请求URL POST https://api.weixin.qq.com/shakearound/material/add?access_token=ACCESS_TOKEN&type=TYPE POST数据格式 FORM表单 ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 FORM表单 ? POST数据

数据示例

调用示例（使用curl命令，用FORM表单方式上传一个多媒体文件）： curl -F “media=@IMAGE_NAME” \YPE\ 字段说明

字段 media 图片名字 Icon：摇一摇页面展示的icon图； License：申请开通摇一摇周边功能时需上传的资type 质文件； 若不传type，则默认type=icon 否 说明 是否必填 是 ? 返回数据说明

30

摇一摇周边接口文档

正确返回JSON数据示例：

{

\“pic_url”: “http://shp.qpic.cn/wechat_shakearound_pic/0/1428377032e9dd2797018cad79186e03e8c5aec8dc/120” }, \ \} 字段说明

字段 图片url地址； pic_url 若type=icon，可用在“新增页面”和“编辑页面”的“icon_url”字段； 若type= license，可用在“申请入驻”的“qualification_cert_urls”字段； 说明 2.5 配置设备与页面的关联关系

? 接口说明

配置设备与页面的关联关系。支持建立或解除关联关系，也支持新增页面或覆盖页面等操作。配置完成后，在此设备的信号范围内，即可摇出关联的页面信息。在申请设备ID后，可直接使用接口直接配置页面。若设备配置多个页面，则随机出现页面信息。一个设备最多可配置30个关联页面。

? 接口调用说明

协议 https 31

摇一摇周边接口文档 http请求方式 请求URL POST https://api.weixin.qq.com/shakearound/device/bindpage?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例

{ \ \ \ \ \ }, \ \ \ } 字段说明

字段 page_ids device_identifier device_id

说明 待关联的页面列表 指定页面的设备ID 设备编号，若填了UUID、major、minor，则32

是否必填 是 是 是 摇一摇周边接口文档 可不填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor，三个信息需填写完整，UUID、major、minor 若填了设备编号，则可不填此信息 关联操作标志位， 0为解除关联关系，1为建bind 立关联关系 append 新增操作标志位， 0为覆盖，1为新增 是 是 是 ? 返回数据说明

正确返回JSON数据示例：

{ \ }, \ \}

2.6 获取摇周边的设备及用户信息

? 接口说明

获取设备信息，包括UUID、major、minor，以及距离、openID等信息。

? 接口调用说明

协议 http请求方式 https POST 33

摇一摇周边接口文档 请求URL https://api.weixin.qq.com/shakearound/user/getshakeinfo?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例 { \”6ab3d8465166598a5f4e8c1b44f44645”, \} 字段说明

字段 说明 摇周边业务的ticket，可在摇到的URL中得到，ticketticket 生效时间为30分钟, 每一次摇都会重新生成新的ticket Need_poi 是否需要返回门店poi_id，传1则返回，否则不返回；门店相关信息具体可查看门店相关的接口文档 否 是否必填 是 ? 返回数据说明

正确返回JSON数据示例：

34

摇一摇周边接口文档

{ \ \ \ \ \ \ \ }, \ \ }, \ \} 字段说明

字段 beacon_info 说明 设备信息，包括UUID、major、minor，以及距离

UUID、major、minor UUID、major、minor distance page_id openid poi_id Beacon信号与手机的距离，单位为米 摇周边页面唯一ID 商户AppID下用户的唯一标识 门店ID，有的话则返回，反之不会在JSON格式内 2.7 数据统计

2.7.1 以设备为维度的数据统计接口

? 接口说明

查询单个设备进行摇周边操作的人数、次数，点击摇周边消息的人数、次数；查询的最长时

35

摇一摇周边接口文档

间跨度为30天。此接口无法拉取当天的数据，最早只能取到前一天的数据。由于系统在凌晨处理前一天的数据，太早调用些接口可能拉取不到数据，建议在早上8：00之后调用此接口。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/statistics/device?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例

36

摇一摇周边接口文档

{ \ \ \ \ \ }, \ \ }

字段说明

字段 device_identifier 指定页面的设备ID 设备编号，若填了UUID、major、minor，即可device_id 不填设备编号，二者选其一 UUID、major、minor，三个信息需填写完成，UUID、major、minor 若填了设备编辑，即可不填此信息，二者选其一 begin_date end_date 起始日期时间戳，最长时间跨度为30天 结束日期时间戳，最长时间跨度为30天 是 是 是 是 说明 是否必填 是 ? 返回数据说明

正确返回JSON数据示例：

37

摇一摇周边接口文档

{ \ { \ \ \ \ \ }, { \ \ \ \ \ } ], \ \} 字段说明

字段 ftime click_pv click_uv shake_pv shake_uv 当天0点对应的时间戳 点击摇周边消息的次数 点击摇周边消息的人数 摇周边的次数 摇周边的人数 说明

2.7.2 以页面为维度的数据统计接口

? 接口说明

查询单个页面通过摇周边摇出来的人数、次数，点击摇周边页面的人数、次数；查询的最长

38

摇一摇周边接口文档

时间跨度为30天。此接口无法拉取当天的数据，最早只能取到前一天的数据。由于系统在凌晨处理前一天的数据，太早调用些接口可能拉取不到数据，建议在早上8：00之后调用此接口。

? 接口调用说明

协议 http请求方式 请求URL https POST https://api.weixin.qq.com/shakearound/statistics/page?access_token=ACCESS_TOKEN POST数据格式 JSON ? 请求参数说明

参数 access_token POST数据 是否必须 是 是 说明 调用接口凭证 JSON数据 ? POST数据

数据示例

{ \ \ \} 字段说明

字段

说明 39

是否必填 摇一摇周边接口文档 page_id begin_date end_date 指定页面的设备ID 起始日期时间戳，最长时间跨度为30天 结束日期时间戳，最长时间跨度为30天 是 是 是 ? 返回数据说明

正确返回JSON数据示例：

{ \ { \ \ \ \ \ }, { \ \ \ \ \ } ], \ \} 字段说明

字段 ftime click_pv click_uv shake_pv 当天0点对应的时间戳 打开摇周边页面的次数 打开摇周边页面的人数 摇出摇周边页面的次数 40

说明

摇一摇周边接口文档 shake_uv 摇出摇周边页面的人数 2.8 摇一摇关注JS API

? 接口说明

摇一摇关注JS API目的是为已开通微信摇一摇周边，且有一定开发能力的商户提供摇一摇关注能力。商户可以在摇出来的页面直接调用摇一摇关注接口，实现关注公众账号的功能。

此接口在公众号使用摇一摇周边累计用户达500人后才可使用。若满足条件，则系统在第二天自动开启此接口权限。累计用户数可在摇一摇周边商户后台的效果监控页面查看。

注意事项：

1) 使用摇一摇关注时，不可诱导用户关注，一经查实，封号处罚；

2) 摇一摇关注仅在摇一摇·周边出来的H5页面才能正常运行。直接在微信浏览器中

打开网页，此接口无法运行。开发人员调试的时候注意，必须走完整的摇周边流程，通过摇一摇进入页面测试。

? 数据示例

关注JS API调用与微信的JS API调用格式一致，如下：

41

摇一摇周边接口文档 公用函数 invoke 用途 主动调用指定API 通用形式 BeaconAddContactJsBridge.invoke(\名称\调用参数}, <回调函数>); 注意：文档中所有代码只能在微信摇周边的场景下才能正确运行。直接在微信浏览器中打开网页，BeaconAddContactJsBridge不会正确运行。开发人员调试的时候注意，必须走完整的摇周边流程，通过摇一摇进入页面测试。 例子：

test

BeaconAddContactJsBridge.invoke('jumpAddContact'); } }else{ alert(apiResult.err_msg) } ? 引入BeaconAddContactJsBridge

? API详细说明

(一) 判断是否关注checkAddContactStatus

a) 参数：无，传入{}

b) 回调函数：function(apiResult){}

apiResult.err_code : 错误码，0代表正常返会，其他代表发生错误。

apiResult.err_msg : 错误详情，“ok”代表正常返回，其他代表具体的错误信息。 apiResult.data : 是否关注，1代表已经关注，0代表未关注 例子：

BeaconAddContactJsBridge.invoke('checkAddContactStatus',{} , function(apiResult){ if(apiResult.err_code == 0){ var status = apiResult.data; if(status == 1){ alert('已关注'); }else{ 43

摇一摇周边接口文档 alert('未关注'); } }else{ alert(apiResult.err_msg) } }); (二) 跳转到关注页jumpAddContact

a) 参数：无。JS API通过查询后台获取设备所归属的公众账号，而不是直接在JS

API参数中获取，因此只能关注此设备归属的公众账号。 b) 回调函数：无 例子：

BeaconAddContactJsBridge.invoke('jumpAddContact'); 2.9 事件通知

2.9.1 摇一摇事件通知

? 接口说明

用户进入摇一摇界面，在“周边”页卡下摇一摇时，微信会把这个事件推送到开发者填写的URL。推送内容包含摇一摇时“周边”页卡展示出来的页面所对应的设备信息，以及附近最多五个属于该公众账号的设备的信息。

? 推送XML数据包示例：

44

摇一摇周边接口文档

1433332012 major minor 0.057 major minor 166.816 major minor 15.013

? 参数说明：

字段 ToUserName FromUserName CreateTime MsgType Event

说明 开发者微信号。 摇一摇用户（一个OpenID）。 消息创建时间 （整型）。 消息类型，event 事件类型，ShakearoundUserShake 45

摇一摇周边接口文档 UUID、major、minor UUID、major、minor Distance 设备与用户的距离（浮点数；单位：米） 3 接口频率限制说明

普通的公众账号每日调用上限如下表所示。

若账号的关注用户数多于20000但少于10万，2000次的上限会增加至20000次，20000次的上限会增加至200000次，200000次的上限会增加至2000000次，1000000次的上限会增加至2000000次。

若账号的关注用户数多于10万但少于100万，2000次的上限会增加至200000次，20000次的上限会增加至2000000次，200000次的上限会增加至10000000次，1000000次的上限会增加至4000000次。

若账号的关注用户数多于100万但少于1000万，2000次的上限会增加至2000000次，20000次的上限会增加至20000000次，200000次的上限会增加至20000000次，1000000次的上限会增加至8000000次。

模块 具体接口 申请开通功能 申请开通摇一摇周边 查询审核状态 申请设备ID 查询设备ID申请状态 设备管理 编辑设备信息 配置设备与门店的关联关系 46

每日调用上限/次 2000 2000 2000 2000 2000 20000 摇一摇周边接口文档 查询设备列表 新增页面 编辑页面信息 页面管理 查询页面列表 删除页面 素材管理 配置设备与页面的关联关系 获取设备及用户信息 上传图片素材 配置设备与页面的关联关系 2000 2000 2000 200000 200000 2000 2000 获取摇周边的设备及用户信息 1000000 以设备为维度的数据统计接口 2000 数据统计 以页面为维度的数据统计接口 2000 摇一摇关注JS API

摇一摇关注JS API 不限 47

摇一摇周边接口文档

4 错误码说明

公众号每次调用接口时，可能获得正确或错误的返回码，开发者可以根据返回码信息调试接口，排查错误。

返回码 9001001 9001002 9001003 9001004 9001005 9001006 9001007 9001008 9001009 9001010 9001020 9001021 9001022 9001023 9001024 9001025 POST数据参数不合法 远端服务不可用 Ticket不合法 获取摇周边用户信息失败 获取商户信息失败 获取OpenID失败 上传文件缺失 上传素材的文件类型不合法 上传素材的文件尺寸不合法 上传失败 帐号不合法 已有设备激活率低于50%，不能新增设备 设备申请数不合法，必须为大于0的数字 已存在审核中的设备ID申请 一次查询设备ID数量不能超过50 设备ID不合法 说明 48

摇一摇周边接口文档 9001026 9001027 9001028 9001029 9001030 9001031 9001032 9001033 9001034 9001035 9001036 9001037 9001038 9001039 9001040 9001041 9001042 9001043 页面ID不合法 页面参数不合法 一次删除页面ID数量不能超过10 页面已应用在设备中，请先解除应用关系再删除 一次查询页面ID数量不能超过50 时间区间不合法 保存设备与页面的绑定关系参数错误 门店ID不合法 设备备注信息过长 设备申请参数不合法 查询起始值begin不合法 单个设备绑定页面不能超过30个 设备总数超过了限额 不合法的联系人名字 不合法的联系人电话 不合法的联系人邮箱 不合法的行业id 不合法的资质证明文件url，文件需通过“素材管理”接口上传 9001044 9001045 缺少资质证明文件 申请理由不能超过500字 49

摇一摇周边接口文档 9001046 9001047 9001048

公众账号未认证 不合法的设备申请批次id 审核状态为审核中或审核已通过，不能再提交申请请求

50

本文来源：https://www.bwwdw.com/article/dsg8.html