API Description
Applies for the UUID, Major, and Minor required to configure the device. After the application is successful, the batch ID is returned, and the returned batch ID can be used to query the current application review status through the "Query Review Status by Device ID" API.
If the number of device IDs for a single application is less than 500, the system will conduct a quick review; if the number of device IDs for a single application is greater than 500, the review will be completed within three business days.
If the review has been passed, you can use the returned batch ID to pull the device ID of this application via the "Query Device List" API. The page needs to be configured first for the device ID applied via the API. If the page is not configured, the page information cannot be displayed after shaking.
An Official Account can apply for up to 10,000 device IDs. If the number of device IDs to be applied for exceeds the maximum limit, contact us by emailing to zhoubian@tencent.com with the following email format:
Subject: Application for Increasing the Limit of Device IDs Text: 1. Official Account name and appid (a string starting with wx, which can be checked on the mp platform) 2. Use 3. Estimated number of device IDs required.
API Request Format
HTTP request method: POST (use the HTTPS protocol) https://api.weixin.qq.com/shakearound/device/applyid?access_token=ACCESS_TOKENPOST data format: jsonPOST data example:{ "quantity":3, "apply_reason":"Test", "comment":"Only for test", "poi_id":1234 }
Parameters
| Parameter | Required | Description |
|---|---|---|
| access_token | Yes | The credential for calling the API |
| quantity | Yes | The number of device IDs to be applied for. If more than 500 devices are added at a time, the manual review process is required. |
| apply_reason | Yes | Reason for application, with a maximum length of 100 Chinese characters (200 English characters). |
| comment | No | Remarks, with a maximum length of 15 Chinese characters (30 English characters). |
| poi_id | No | The store ID linked with the device. Information can be preferentially obtained via the Shake-Nearby feature within the range of 1KM. For more information about the store, see the API documentation related to the store. |
Response
Example of JSON packet returned for a successful request:
{"data": {
"apply_id": 123,
"audit_status": 1,
"audit_comment": "Under review"
},
"errcode": 0,
"errmsg": "success."
}
Parameters
| Parameter | Description |
|---|---|
| audit_status | Review status. 0: Rejected; 1: Under review; 2: Approved; If the number of device IDs for a single application is less than 500, the system will conduct a quick review. If the number of device IDs for a single application is greater than 500, the review will be completed within three business days. In this case, the return value is 1 (Under review). |
| audit_comment | Review remarks. Text description of the review status. |
| apply_id | The IDs applied in batch. The device IDs that were successfully applied for this time can be queried in batch in the "Query Device List" API. |