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
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| group_id | string | Yes | Group 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
| Parameter | Data Type | Description | |
|---|---|---|---|
| group_id | string | Group ID. | |
| group_name | string | Group name. | |
| is_mute | int | Global mute status. 0: not muted; 1: muted. | |
| ext_fields | map | Additional group fields. |
Response Example
{
"code":0,
"msg":"sucess",
"data":{
"group_id":"group1",
"group_name":"group1",
"is_mute":0,
"ext_fields":{
"field1":"aaa",
"field2":"bbb"
}
}
}