Overview
IM Server stores group information for display in conversations. When group information changes, call this API to synchronize the updated information to IM Server.
Group Information Synchronization
After group information is updated, IM Server does not proactively notify clients. The latest group information is automatically synchronized to clients when the group receives a new message.
Request
Authentication Add authentication headers to the request. See Authentication
Method
POST
Rate limit
100 requests/second
Endpoint https://API domain/apigateway/groups/update
Content-Type
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
group_id | string | Yes | Group ID. Maximum length: 64 characters. | |
| group_name | string | No | Group name. Maximum length: 64 characters. | |
| group_portrait | string | No | Group avatar. Maximum length: 200 characters. | |
| ext_fields | map | No | Extended fields. Keys can contain up to 50 characters; values can contain up to 1,000 characters. |
Request Example
POST /apigateway/groups/update HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"group_id":"group1",
"group_name":"group1",
"group_portrait":"xxx",
"ext_fields":{
"field1":"aaa",
"field2":"bbb"
}
}
Response Example
{
"code":0,
"msg":"sucess"
}