Mute a User in a Chatroom
The chatroom service supports muting users, allowing you to mute one or more specified users in a specific chatroom. Apps can use this feature to mute members in their chatrooms. Muted users can still receive and view messages from other users in the chatroom but cannot send messages.
The muted status remains effective even if the user leaves the chatroom.
The Server API for sending chatroom messages is not restricted by the muted status. Muted users can still send messages to the chatroom via the Server API.
Request Method
POST: https://data center domain/chatroom/user/gag/add.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests must be validated according to the signature rules. For details, see API Request Signature.
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | User ID. Multiple users can be muted simultaneously, with a maximum of 20 users. |
| chatroomId | String | Yes | Chatroom ID. |
| minute | String | Yes | Mute duration in minutes, with a maximum value of 43,200 minutes. |
| extra | String | No | JSON-formatted extended information carried in the notification, valid only 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 in the specified chatroom. |
Request Example
POST /chatroom/user/gag/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
userId=2583&userId=2582&chatroomId=16&minute=1
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Return Type | Description |
|---|---|---|
| code | Number | Return code, 200 indicates success. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}