API Description

Queries group details, including the group name, group ID, and device list in the group.

API Request Format

HTTP request method: POST (use the HTTPS protocol)https://api.weixin.qq.com/shakearound/device/group/getdetail?access_token=ACCESS_TOKEN
POST data format: json
POST data example:
{
  "group_id":123
  "begin":0,
  "count":100
}

Parameters

Parameter Required Description
access_token Yes The credential for calling the API
group_id Yes The globally unique identifier of the group
begin Yes The starting index value of the device in the group
count Yes The number of devices in the group to be queried. Maximum is 1,000.

Response

Example of JSON packet returned for a successful request:

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

Parameters

Parameter Description
group_id The globally unique identifier of the group
group_name Group name
total_count The total number of devices in this group
devices List of devices in this group
device_id The globally unique ID of the device
uuid, major, minor uuid, major, minor
comment Remarks of the device
poi_id 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.