Overview
Retrieves the group member list.
Request
Authentication: Add authentication headers to the request. See Authentication
Method:
GET
Rate limit:
100 requests/second
Endpoint: https://API domain/jim/groups/members/list
Content-Type:
application/json
Request parameters
| Parameter | Data type | Required | Description | |
|---|---|---|---|---|
| group_id | string | Yes | Group ID. | |
| limit | int | No | Pagination count. | |
| offset | string | No | Pagination offset returned by the previous request. |
Request example
GET /jim/groups/members/list?group_id=groupid1&limit=20&offset=xxx HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json
Response example
{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"userid1",
"nickname":"user1",
"avatar":"https://aaabbcc.png",
"member_type":0,// 0:regular user; 1: bot;
"role":0 //0:group member; 1: group owner; 2: group administrator
},{
"user_id":"userid2",
"nickname":"user2",
"avatar":"https://aaabbcc.png",
"member_type":0,// 0:regular user; 1: bot;
"role":0 //0:group member; 1: group owner; 2: group administrator
}
],
"offset":"xxx"
}
}
Response codes
| Response codes | Description |
|---|