Skip to main content

Overview

Retrieves group information.

Request

Authentication: Add authentication headers to the request. See Authentication

Method: GET

Rate limit: 100 requests/second

Endpoint: https://API domain/jim/groups/info

Content-Type: application/json

Request parameters

ParameterData typeRequiredDescription
group_idstringYesGroup ID.

Request example

GET /jim/groups/info?group_id=groupid1 HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json

Response example

{
"code":0,
"msg":"sucess",
"data":{
"group_id":"groupid1",
"group_name":"group1",
"group_portrait":"https://aaaa.png",
"member_count":10,
"members":[
{
"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
}
],
"owner":{
"user_id":"userid1",
"nickname":"user1",
"avatar":"https://aaabbcc.png"
},
"my_role":0, //my role in this group. 0: group member; 1: group owner; 2: group administrator;
"group_management":{
"group_mute":0,//whether group-wide muting is enabled;
"max_admin_count":10,//maximum number of group administrators;
"admin_count":2,//current number of administrators;
"group_verify_type":0,// 0: no verification; 1: administrator approval required; 2: reject new members;
},
"grp_display_name":"grp1"// my group nickname
}
}

Response codes

Response codesDescription