Add Users to Chatroom Mute Exceptions List

Add one or more chatroom members to the specified chatroom's Mute Exceptions list.

• After being added to the chatroom's Mute Exceptions list, members can still send messages to the chatroom via the client SDK even if the chatroom is set to Mute All.
• If a user in the Mute Exceptions list voluntarily leaves the chatroom or is removed due to a ban, their Mute Exceptions status remains valid upon rejoining.
• If the chatroom is destroyed and recreated, the previous Mute Exceptions status automatically becomes invalid.

Relationship between Mute Exceptions and other mute features:

• Mute a User in the chatroom does not affect the Mute Exceptions status. Even if a user is muted individually in the chatroom, they can still send messages to the chatroom via the client SDK after being added to the Mute Exceptions list.
• Mute All in the chatroom affects the Mute Exceptions feature. If a user added to the Mute Exceptions list is still unable to send messages to the chatroom via the client SDK, check if the user has been muted in all chatrooms under the App Key.

tip

The server-side (Server API) interface for sending chatroom messages is not restricted by the chatroom's Mute All status. Muted users can still send messages to the chatroom via Server API.

Request Method

POST: https://Data Center Domain/chatroom/user/ban/whitelist/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 it supports the following HTTP form parameters:

Parameter	Type	Required	Description
chatroomId	String	Yes	Chatroom ID
userId	String	Yes	User ID to be added to the Mute Exceptions list. The list supports up to 20 users and allows batch addition, with a maximum of 20 users per request.
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/ban/whitelist/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=LoDld8izA&userId=uu1&userId=uu2

Response

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

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