Set Chatroom Mute All
The chatroom feature supports muting all members in a chatroom. Apps can call this API to add the specified chatroom to the server-side Mute All list.
- Once a chatroom is added to the Mute All list, the mute status takes effect immediately. All members of the chatroom will be unable to send messages via the client SDK. To allow exceptions for specific users, you can add them to the chatroom mute whitelist. For details, see Add to Chatroom Mute Whitelist.
- If the chatroom is disbanded, the Mute All data will be cleared.
tip
The server-side (Server API) chatroom message sending interface is not restricted by the Mute All status. Muted users can still send messages to the chatroom via the Server API.
Request Method
POST: https://data center domain/chatroom/ban/add.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests require signature validation. For details, see API Request Signature.
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, supporting the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| chatroomId | String | Yes | The ID of the chatroom to be muted. |
| extra | String | No | The JSON-formatted extended information carried in the notification, only valid when needNotify is true. |
| needNotify | boolean | No | Whether to notify members. Default is false (no notification). If set to true, the client will trigger the corresponding callback method (requires Android/iOS IMLib ≧ 5.4.5; Web IMLib ≧ 5.7.9). Notification scope: all members of the specified chatroom. |
Request Example
POST /chatroom/ban/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
chatroomId=123
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Return Type | Description |
|---|---|---|
| code | Number | Return code, 200 for success. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}