API Description

Queries all the groups under the account.

API Request Format

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

Parameters

Parameter Required Description
access_token Yes The credential for calling the API
begin Yes The starting index value for group list
count Yes The number of groups to be queried. Maximum is 1,000.

Response

Example of JSON packet returned for a successful request:

{
  "data": {
  "total_count": 100,
      "groups":[
       {
          "group_id" : 123,
          "group_name" : "test1"
      },
      {
          "group_id" : 124,
          "group_name" : "test2"
      }
     ]
  },
  "errcode": 0,
  "errmsg": "success."
}

Parameters

Parameter Description
total_count Yes Total number of existing groups under this account
groups Yes Group list
group_id Yes The globally unique identifier of the group
group_name Yes Group name