Overview
Updates group settings. For example, you can specify whether newly joined group members can access previous message history.
Request
Authentication Add authentication headers to the request. See Authentication
Method
POST
Rate limit
100 requests/second
Endpoint https://API domain/apigateway/groups/settings/set
Content-Type
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
group_id | string | Yes | Group ID. Maximum length: 64 characters. | |
| hide_grp_msg | int | No | Whether to hide message history sent before a member joined the group: 0 does not hide it; 1 hides it. |
Request Example
POST /apigateway/groups/settings/set HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"group_id":"groupid1",
"settings":{
"hide_grp_msg":1,
"grp_msg_second_limiter":0, // maximum group messages per second for one group; 0 means unlimited
"grp_msg_minute_limiter":0, // maximum group messages per minute for one group; 0 means unlimited
"grp_msg_hour_limiter":0 // maximum group messages per hour for one group; 0 means unlimited
}
}
Response Example
{
"code":0,
"msg":"sucess"
}