Mute a User in All Chatrooms

The chatroom service supports muting specified users in all chatrooms under the application, and allows setting the mute duration.

During the mute period, muted users cannot send messages via the client SDK in any chatroom under the application.

Enable the Service

Before using the Mute All Chatrooms feature, ensure that the service has been enabled for the current App Key.

If the service is not enabled, the Server API will return the 1009 error. Note that if the service is not enabled and continuous requests cause the API request frequency to exceed the limit, the Server API will return the HTTP 429 Too Many Requests error (error code 1008).

Request Method

POST: https://data center domain/chatroom/user/ban/add.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature verification. For details, refer to API Request Signature.

Body Parameters

The HTTP request body data format is application/x-www-form-urlencoded, and supports the following HTTP form parameters:

Parameter	Type	Required	Description
userId	String	Yes	User ID. Multiple users can be muted at the same time, with a maximum of 20 users per request.
minute	String	Yes	Mute duration in minutes, with a maximum value of 43200 minutes.
extra	String	No	JSON-formatted extended information carried by the notification, valid only when needNotify is true.
needNotify	boolean	No	Whether to notify members. Default is false. 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: muted users.

Request Example

POST /chatroom/user/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

userId=2582&userId=2583&minute=1

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	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}