Block Chatroom Users

The chatroom service supports the function of blocking users, allowing you to block one or more users in a specified chatroom.

• If a user is in the chatroom when blocked, they will be immediately removed from the chatroom.
• Blocked users cannot join the chatroom during the blocking period.

Request Method

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

Rate Limit: 100 requests per second

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

Request Parameters

The HTTP request body is formatted as 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 blocked simultaneously, with a maximum of 20 users.
chatroomId	String	Yes	Chatroom ID.
minute	String	Yes	Blocking duration in minutes. The maximum value is 43200 minutes.
extra	String	No	JSON-formatted extended information carried in the notification, effective 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 chatroom, including blocked users.

Request Example

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