阅读(2575)
赞(0)
微信设备ID
2016-09-30 10:42:21 更新
申请设备ID
接口说明
申请配置设备所需的UUID、Major、Minor。申请成功后返回批次ID，可用返回的批次ID通过“查询设备ID申请状态”接口查询目前申请的审核状态。
若单次申请的设备ID数量小于500个，系统会进行快速审核；若单次申请的设备ID数量大于等 500个 ，会在三个工作日内完成审核。
如果已审核通过，可用返回的批次ID通过“查询设备列表”接口拉取本次申请的设备ID。 通过接口申请的设备ID，需先配置页面，若未配置页面，则摇不出页面信息。
一个公众账号最多可申请100000个设备ID，如需申请的设备ID数超过最大限额，请邮件至zhoubian@tencent.com，邮件格式如下：
标题：申请提升设备ID额度
内容：
1、公众账号名称及appid（wx开头的字符串，在mp平台可查看）
2、用途
3、预估需要多少设备ID
接口调用说明
http请求方式: POST（请使用https协议）https://api.weixin.qq.com/shakearound/device/applyid?access_token=ACCESS_TOKENPOST数据格式：json
POST数据例子：
{
"quantity":3,
"apply_reason":"测试",
"comment":"测试专用",
"poi_id":1234
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| quantity | 是 | 申请的设备ID的数量，单次新增设备超过500个，需走人工审核流程 |
| apply_reason | 是 | 申请理由，不超过100个汉字或200个英文字母 |
| comment | 否 | 备注，不超过15个汉字或30个英文字母 |
| poi_id | 否 | 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会。门店相关信息具体可查看门店相关的接口文档 |
返回说明
正常时的返回JSON数据包示例：
{
"data": {
"apply_id": 123,
"audit_status": 1,
"audit_comment": "审核中"
},
"errcode": 0,
"errmsg": "success."
}
参数说明
| 参数 | 说明 |
|---|---|
| audit_status | 审核状态。0：审核未通过、1：审核中、2：审核已通过；若单次申请的设备ID数量小于等于500个，系统会进行快速审核；若单次申请的设备ID数量大于500个，会在三个工作日内完成审核；此时返回值全部为1(审核中) |
| audit_comment | 审核备注，对审核状态的文字说明 |
| apply_id | 申请的批次ID，可用在“查询设备列表”接口按批次查询本次申请成功的设备ID。 |
查询设备ID申请审核状态
接口说明
查询设备ID申请的审核状态。若单次申请的设备ID数量小于等于500个，系统会进行快速审核；若单次申请的设备ID数量大于500个，则在三个工作日内完成审核。
接口调用说明
http请求方式: POST（请使用https协议）https://api.weixin.qq.com/shakearound/device/applystatus?access_token=ACCESS_TOKENPOST数据格式：json
POST数据例子：
{
"apply_id": 12345
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| apply_id | 是 | 批次ID，申请设备ID时所返回的批次ID |
返回说明
正常时的返回JSON数据包示例：
{
"data": {
"apply_time": 1432026025,
"audit_comment": "test",
"audit_status": 1,
"audit_time": 0
},
"errcode": 0,
"errmsg": "success."
}
参数说明
| 参数 | 说明 |
|---|---|
| apply_time | 提交申请的时间戳 |
| audit_status | 审核状态。0：审核未通过、1：审核中、2：审核已通过；若单次申请的设备ID数量小于等于500个，系统会进行快速审核；若单次申请的设备ID数量大于500个，会在三个工作日内完成审核； |
| audit_comment | 审核备注，对审核状态的文字说明 |
| audit_time | 确定审核结果的时间戳，若状态为审核中，则该时间值为0 |
编辑设备信息
接口说明
编辑设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备，二者选其一。
接口调用说明
http请求方式: POST（请使用https协议）https://api.weixin.qq.com/shakearound/device/update?access_token=ACCESS_TOKENPOST数据格式：json
POST数据例子：
{
"device_identifier":{
"device_id":10011,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":1002,
"minor":1223
},
"comment": “test”
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| device_identifier | 是 | 指定的设备ID |
| device_id | 是 | 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先 |
| UUID、major、minor | 是 | UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息。 |
| comment | 是 | 设备的备注信息，不超过15个汉字或30个英文字母。 |
返回说明
正常时的返回JSON数据包示例：
{
"data": {
},
"errcode": 0,
"errmsg": "success."
}
配置设备与门店的关联关系
接口说明
支持创建门店后直接关联在设备上，无需为审核通过状态，摇周边后台自动更新门店的最新信息和状态。
接口调用说明
http请求方式: POST（请使用https协议）https://api.weixin.qq.com/shakearound/device/bindlocation?access_token=ACCESS_TOKENPOST数据格式：json
POST数据例子：
{
"device_identifier":{
"device_id":10011,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":1002,
"minor":1223
},
"poi_id": 1231,
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| device_identifier | 是 | 指定的设备ID |
| device_id | 是 | 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先 |
| UUID、major、minor | 是 | UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息。 |
| poi_id | 是 | 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会。当值为0时，将清除设备已关联的门店ID。门店相关信息具体可查看门店相关的接口文档 |
返回说明
正常时的返回JSON数据包示例：
{
"data": {
},
"errcode": 0,
"errmsg": "success."
}配置设备与其他公众账号门店的关联关系
接口说明
支持设备关联其他公众账号的门店，门店需为审核通过状态。
因为第三方门店不归属本公众账号，所以未保存到设备详情中，查询设备列表接口与获取摇周边的设备及用户信息接口不会返回第三方门店。如需验证请使用摇一摇关注JS API验证。
若设备上绑定自己门店，则自动屏蔽第三方门店相关功能。
接口调用说明
http请求方式: POST（请使用https协议）https://api.weixin.qq.com/shakearound/device/bindlocation?access_token=ACCESS_TOKENPOST数据格式：json
POST数据例子：
{
"device_identifier":{
"device_id":10011,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":1002,
"minor":1223
},
"poi_id": 1231,
"type": 2,
"poi_appid": "wxappid"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| device_identifier | 是 | 指定的设备ID |
| device_id | 是 | 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先 |
| UUID、major、minor | 是 | UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息。 |
| poi_id | 是 | 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会。当值为0时，将清除设备已关联的门店ID。门店相关信息具体可查看门店相关的接口文档 |
| Type | 否，不填默认为1 | 为1时，关联的门店和设备归属于同一公众账号； 为2时，关联的门店为其他公众账号的门店 |
| Poi_appid | 当Type为2时，必填 | 关联门店所归属的公众账号的APPID |
返回说明 正常时的返回JSON数据包示例：
{
"data": {
},
"errcode": 0,
"errmsg": "success."
}查询设备列表
接口说明
查询已有的设备ID、UUID、Major、Minor、激活状态、备注信息、关联门店、关联页面等信息。可指定设备ID或完整的UUID、Major、Minor查询，也可批量拉取设备信息列表。查询所返回的设备列表按设备ID正序排序。
接口调用说明
http请求方式: POST（请使用https协议）https://api.weixin.qq.com/shakearound/device/search?access_token=ACCESS_TOKENPOST数据格式：json
POST数据例子：
查询指定设备时：
{
"type": 1,
"device_identifiers":[
{
"device_id":10100,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":10001,
"minor":10002
}
]
}
需要分页查询或者指定范围内的设备时：
{
"type": 2,
"last_seen": 10097,
"count": 3
}
当需要根据批次ID查询时：
{
"type": 3,
"apply_id": 1231,
"last_seen": 10097,
"count": 3
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| type | 是 | 查询类型。1：查询设备id列表中的设备；2：分页查询所有设备信息；3：分页查询某次申请的所有设备信息 |
| device_identifiers | 是 | 指定的设备 ； 当type为1时，此项为必填 |
| device_id | 是 | 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先；查询指定设备时，单次查询的设备数量不能超过50个 |
| UUID、major、minor | 是 | UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息；查询指定设备时，单次查询的设备数量不能超过50个 |
| apply_id | 是 | 批次ID，申请设备ID时所返回的批次ID；当type为3时，此项为必填 |
| last_seen | 是 | 前一次查询列表末尾的设备ID ， 第一次查询last_seen 为0 |
| count | 是 | 待查询的设备数量，不能超过50个 |
返回说明
正常时的返回JSON数据包示例：
{
"data": {
"devices": [
{
"comment": "",
"device_id": 10097,
"major": 10001,
"minor": 12102,
"status": 1,
"last_active_time":1437276018,
"poi_id": 0,
"uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
},
{
"comment": "",
"device_id": 10098,
"major": 10001,
"minor": 12103,
"status": 1,
"last_active_time":1437276018,
"poi_appid":"wxe3813f5d8c546fc7"
"poi_id": 123,
"uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825"
}
],
"total_count": 151
},
"errcode": 0,
"errmsg": "success."
}
参数说明
| 参数 | 说明 |
|---|---|
| devices | 指定的设备信息列表 |
| device_id | 设备编号 |
| UUID、major、minor | UUID、major、minor |
| status | 激活状态，0：未激活，1：已激活 |
| last_active_time | 设备最近一次被摇到的日期（最早只能获取前一天的数据）；新申请的设备该字段值为0 |
| poi_appid | 若配置了设备与其他公众账号门店关联关系，则返回配置门店归属的公众账号appid。查看配置设备与其他公众账号门店关联关系接口 |
| poi_id | 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会。门店相关信息具体可查看门店相关的接口文档 |
| comment | 设备的备注信息 |
| total_count | 商户名下的设备总量 |