接口說明
申請(qǐng)配置設(shè)備所需的UUID、Major、Minor。申請(qǐng)成功后返回批次ID,可用返回的批次ID通過“查詢?cè)O(shè)備ID申請(qǐng)狀態(tài)”接口查詢目前申請(qǐng)的審核狀態(tài)。
若單次申請(qǐng)的設(shè)備ID數(shù)量小于500個(gè),系統(tǒng)會(huì)進(jìn)行快速審核;若單次申請(qǐng)的設(shè)備ID數(shù)量大于等 500個(gè) ,會(huì)在三個(gè)工作日內(nèi)完成審核。
如果已審核通過,可用返回的批次ID通過“查詢?cè)O(shè)備列表”接口拉取本次申請(qǐng)的設(shè)備ID。 通過接口申請(qǐng)的設(shè)備ID,需先配置頁(yè)面,若未配置頁(yè)面,則搖不出頁(yè)面信息。
一個(gè)公眾賬號(hào)最多可申請(qǐng)100000個(gè)設(shè)備ID,如需申請(qǐng)的設(shè)備ID數(shù)超過最大限額,請(qǐng)郵件至zhoubian@tencent.com,郵件格式如下:
標(biāo)題:申請(qǐng)?zhí)嵘O(shè)備ID額度
內(nèi)容:
1、公眾賬號(hào)名稱及appid(wx開頭的字符串,在mp平臺(tái)可查看)
2、用途
3、預(yù)估需要多少設(shè)備ID
接口調(diào)用說明
http請(qǐng)求方式: POST(請(qǐng)使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/applyid?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
"quantity":3,
"apply_reason":"測(cè)試",
"comment":"測(cè)試專用",
"poi_id":1234
}
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
quantity | 是 | 申請(qǐng)的設(shè)備ID的數(shù)量,單次新增設(shè)備超過500個(gè),需走人工審核流程 |
apply_reason | 是 | 申請(qǐng)理由,不超過100個(gè)漢字或200個(gè)英文字母 |
comment | 否 | 備注,不超過15個(gè)漢字或30個(gè)英文字母 |
poi_id | 否 | 設(shè)備關(guān)聯(lián)的門店ID,關(guān)聯(lián)門店后,在門店1KM的范圍內(nèi)有優(yōu)先搖出信息的機(jī)會(huì)。門店相關(guān)信息具體可查看門店相關(guān)的接口文檔 |
返回說明
正常時(shí)的返回JSON數(shù)據(jù)包示例:
{
"data": {
"apply_id": 123,
"audit_status": 1,
"audit_comment": "審核中"
},
"errcode": 0,
"errmsg": "success."
}
參數(shù)說明
參數(shù) | 說明 |
---|---|
audit_status | 審核狀態(tài)。0:審核未通過、1:審核中、2:審核已通過;若單次申請(qǐng)的設(shè)備ID數(shù)量小于等于500個(gè),系統(tǒng)會(huì)進(jìn)行快速審核;若單次申請(qǐng)的設(shè)備ID數(shù)量大于500個(gè),會(huì)在三個(gè)工作日內(nèi)完成審核;此時(shí)返回值全部為1(審核中) |
audit_comment | 審核備注,對(duì)審核狀態(tài)的文字說明 |
apply_id | 申請(qǐng)的批次ID,可用在“查詢?cè)O(shè)備列表”接口按批次查詢本次申請(qǐng)成功的設(shè)備ID。 |
接口說明
查詢?cè)O(shè)備ID申請(qǐng)的審核狀態(tài)。若單次申請(qǐng)的設(shè)備ID數(shù)量小于等于500個(gè),系統(tǒng)會(huì)進(jìn)行快速審核;若單次申請(qǐng)的設(shè)備ID數(shù)量大于500個(gè),則在三個(gè)工作日內(nèi)完成審核。
接口調(diào)用說明
http請(qǐng)求方式: POST(請(qǐng)使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/applystatus?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
"apply_id": 12345
}
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
apply_id | 是 | 批次ID,申請(qǐng)?jiān)O(shè)備ID時(shí)所返回的批次ID |
返回說明
正常時(shí)的返回JSON數(shù)據(jù)包示例:
{
"data": {
"apply_time": 1432026025,
"audit_comment": "test",
"audit_status": 1,
"audit_time": 0
},
"errcode": 0,
"errmsg": "success."
}
參數(shù)說明
參數(shù) | 說明 |
---|---|
apply_time | 提交申請(qǐng)的時(shí)間戳 |
audit_status | 審核狀態(tài)。0:審核未通過、1:審核中、2:審核已通過;若單次申請(qǐng)的設(shè)備ID數(shù)量小于等于500個(gè),系統(tǒng)會(huì)進(jìn)行快速審核;若單次申請(qǐng)的設(shè)備ID數(shù)量大于500個(gè),會(huì)在三個(gè)工作日內(nèi)完成審核; |
audit_comment | 審核備注,對(duì)審核狀態(tài)的文字說明 |
audit_time | 確定審核結(jié)果的時(shí)間戳,若狀態(tài)為審核中,則該時(shí)間值為0 |
接口說明
編輯設(shè)備的備注信息??捎迷O(shè)備ID或完整的UUID、Major、Minor指定設(shè)備,二者選其一。
接口調(diào)用說明
http請(qǐng)求方式: POST(請(qǐng)使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/update?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
"device_identifier":{
"device_id":10011,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":1002,
"minor":1223
},
"comment": “test”
}
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
device_identifier | 是 | 指定的設(shè)備ID |
device_id | 是 | 設(shè)備編號(hào),若填了UUID、major、minor,則可不填設(shè)備編號(hào),若二者都填,則以設(shè)備編號(hào)為優(yōu)先 |
UUID、major、minor | 是 | UUID、major、minor,三個(gè)信息需填寫完整,若填了設(shè)備編號(hào),則可不填此信息。 |
comment | 是 | 設(shè)備的備注信息,不超過15個(gè)漢字或30個(gè)英文字母。 |
返回說明
正常時(shí)的返回JSON數(shù)據(jù)包示例:
{
"data": {
},
"errcode": 0,
"errmsg": "success."
}
接口說明
支持創(chuàng)建門店后直接關(guān)聯(lián)在設(shè)備上,無需為審核通過狀態(tài),搖周邊后臺(tái)自動(dòng)更新門店的最新信息和狀態(tài)。
接口調(diào)用說明
http請(qǐng)求方式: POST(請(qǐng)使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/bindlocation?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
"device_identifier":{
"device_id":10011,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":1002,
"minor":1223
},
"poi_id": 1231,
}
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
device_identifier | 是 | 指定的設(shè)備ID |
device_id | 是 | 設(shè)備編號(hào),若填了UUID、major、minor,則可不填設(shè)備編號(hào),若二者都填,則以設(shè)備編號(hào)為優(yōu)先 |
UUID、major、minor | 是 | UUID、major、minor,三個(gè)信息需填寫完整,若填了設(shè)備編號(hào),則可不填此信息。 |
poi_id | 是 | 設(shè)備關(guān)聯(lián)的門店ID,關(guān)聯(lián)門店后,在門店1KM的范圍內(nèi)有優(yōu)先搖出信息的機(jī)會(huì)。當(dāng)值為0時(shí),將清除設(shè)備已關(guān)聯(lián)的門店ID。門店相關(guān)信息具體可查看門店相關(guān)的接口文檔 |
返回說明
正常時(shí)的返回JSON數(shù)據(jù)包示例:
{
"data": {
},
"errcode": 0,
"errmsg": "success."
}
接口說明
支持設(shè)備關(guān)聯(lián)其他公眾賬號(hào)的門店,門店需為審核通過狀態(tài)。
因?yàn)榈谌介T店不歸屬本公眾賬號(hào),所以未保存到設(shè)備詳情中,查詢?cè)O(shè)備列表接口與獲取搖周邊的設(shè)備及用戶信息接口不會(huì)返回第三方門店。如需驗(yàn)證請(qǐng)使用搖一搖關(guān)注JS API驗(yàn)證。
若設(shè)備上綁定自己門店,則自動(dòng)屏蔽第三方門店相關(guān)功能。
接口調(diào)用說明
http請(qǐng)求方式: POST(請(qǐng)使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/bindlocation?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
{
"device_identifier":{
"device_id":10011,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":1002,
"minor":1223
},
"poi_id": 1231,
"type": 2,
"poi_appid": "wxappid"
}
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
device_identifier | 是 | 指定的設(shè)備ID |
device_id | 是 | 設(shè)備編號(hào),若填了UUID、major、minor,則可不填設(shè)備編號(hào),若二者都填,則以設(shè)備編號(hào)為優(yōu)先 |
UUID、major、minor | 是 | UUID、major、minor,三個(gè)信息需填寫完整,若填了設(shè)備編號(hào),則可不填此信息。 |
poi_id | 是 | 設(shè)備關(guān)聯(lián)的門店ID,關(guān)聯(lián)門店后,在門店1KM的范圍內(nèi)有優(yōu)先搖出信息的機(jī)會(huì)。當(dāng)值為0時(shí),將清除設(shè)備已關(guān)聯(lián)的門店ID。門店相關(guān)信息具體可查看門店相關(guān)的接口文檔 |
Type | 否,不填默認(rèn)為1 | 為1時(shí),關(guān)聯(lián)的門店和設(shè)備歸屬于同一公眾賬號(hào); 為2時(shí),關(guān)聯(lián)的門店為其他公眾賬號(hào)的門店 |
Poi_appid | 當(dāng)Type為2時(shí),必填 | 關(guān)聯(lián)門店所歸屬的公眾賬號(hào)的APPID |
返回說明 正常時(shí)的返回JSON數(shù)據(jù)包示例:
{
"data": {
},
"errcode": 0,
"errmsg": "success."
}
接口說明
查詢已有的設(shè)備ID、UUID、Major、Minor、激活狀態(tài)、備注信息、關(guān)聯(lián)門店、關(guān)聯(lián)頁(yè)面等信息??芍付ㄔO(shè)備ID或完整的UUID、Major、Minor查詢,也可批量拉取設(shè)備信息列表。查詢所返回的設(shè)備列表按設(shè)備ID正序排序。
接口調(diào)用說明
http請(qǐng)求方式: POST(請(qǐng)使用https協(xié)議)https://api.weixin.qq.com/shakearound/device/search?access_token=ACCESS_TOKENPOST數(shù)據(jù)格式:json
POST數(shù)據(jù)例子:
查詢指定設(shè)備時(shí):
{
"type": 1,
"device_identifiers":[
{
"device_id":10100,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"major":10001,
"minor":10002
}
]
}
需要分頁(yè)查詢或者指定范圍內(nèi)的設(shè)備時(shí):
{
"type": 2,
"last_seen": 10097,
"count": 3
}
當(dāng)需要根據(jù)批次ID查詢時(shí):
{
"type": 3,
"apply_id": 1231,
"last_seen": 10097,
"count": 3
}
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
type | 是 | 查詢類型。1:查詢?cè)O(shè)備id列表中的設(shè)備;2:分頁(yè)查詢所有設(shè)備信息;3:分頁(yè)查詢某次申請(qǐng)的所有設(shè)備信息 |
device_identifiers | 是 | 指定的設(shè)備 ; 當(dāng)type為1時(shí),此項(xiàng)為必填 |
device_id | 是 | 設(shè)備編號(hào),若填了UUID、major、minor,則可不填設(shè)備編號(hào),若二者都填,則以設(shè)備編號(hào)為優(yōu)先;查詢指定設(shè)備時(shí),單次查詢的設(shè)備數(shù)量不能超過50個(gè) |
UUID、major、minor | 是 | UUID、major、minor,三個(gè)信息需填寫完整,若填了設(shè)備編號(hào),則可不填此信息;查詢指定設(shè)備時(shí),單次查詢的設(shè)備數(shù)量不能超過50個(gè) |
apply_id | 是 | 批次ID,申請(qǐng)?jiān)O(shè)備ID時(shí)所返回的批次ID;當(dāng)type為3時(shí),此項(xiàng)為必填 |
last_seen | 是 | 前一次查詢列表末尾的設(shè)備ID , 第一次查詢last_seen 為0 |
count | 是 | 待查詢的設(shè)備數(shù)量,不能超過50個(gè) |
返回說明
正常時(shí)的返回JSON數(shù)據(jù)包示例:
{
"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."
}
參數(shù)說明
參數(shù) | 說明 |
---|---|
devices | 指定的設(shè)備信息列表 |
device_id | 設(shè)備編號(hào) |
UUID、major、minor | UUID、major、minor |
status | 激活狀態(tài),0:未激活,1:已激活 |
last_active_time | 設(shè)備最近一次被搖到的日期(最早只能獲取前一天的數(shù)據(jù));新申請(qǐng)的設(shè)備該字段值為0 |
poi_appid | 若配置了設(shè)備與其他公眾賬號(hào)門店關(guān)聯(lián)關(guān)系,則返回配置門店歸屬的公眾賬號(hào)appid。查看配置設(shè)備與其他公眾賬號(hào)門店關(guān)聯(lián)關(guān)系接口 |
poi_id | 設(shè)備關(guān)聯(lián)的門店ID,關(guān)聯(lián)門店后,在門店1KM的范圍內(nèi)有優(yōu)先搖出信息的機(jī)會(huì)。門店相關(guān)信息具體可查看門店相關(guān)的接口文檔 |
comment | 設(shè)備的備注信息 |
total_count | 商戶名下的設(shè)備總量 |
更多建議: