Skip to main content

Overview

Queries information about a group for comparison with the data on your application server. Your application server is the source of truth. Synchronize changes to the IM Server promptly.

Request

Authentication: Add authentication headers to the request. See Authentication.

Method GET

Rate limit 100 requests/second

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

Content-Type application/json

Request Parameters

ParameterData TypeRequiredDescription
group_idstringYesGroup ID. Maximum length: 64 characters.

Request Example

GET /apigateway/groups/info?group_id=group1 HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

Response Parameters

ParameterData TypeDescription
group_idstringGroup ID.
group_namestringGroup name.
is_muteintGlobal mute status. 0: not muted; 1: muted.
ext_fieldsmapAdditional group fields.

Response Example

{
"code":0,
"msg":"sucess",
"data":{
"group_id":"group1",
"group_name":"group1",
"is_mute":0,
"ext_fields":{
"field1":"aaa",
"field2":"bbb"
}
}
}