Banned User

Banning an App user is typically used in cases of user violations.

• When banning, a time range must be set, with minutes as the smallest unit. The maximum ban duration is 30 days (43,200 minutes).
• Permanent bans are not supported.
• After the ban period expires, the ban is automatically lifted. You can also actively call the unban method to lift the ban.

Ban specified single or multiple users. The ban takes effect immediately, with the following impacts:

• If the banned user is currently connected to the IM service, the IM connection will be immediately disconnected.
• The banned user cannot establish an IM connection with the IM service and cannot actively use the IM service.
• During the ban period, other users can send messages to the banned user, but the banned user cannot receive messages or push notifications. After the ban is lifted, the user can normally connect and use the IM service. Upon reconnecting, the user can receive offline messages^? from the banned period. Please note that offline messages are stored for a maximum of 7 days. If the client does not go online within 7 days, the server will discard expired messages.

Request Method

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

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature verification. 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
userId	String	Yes	User ID. Supports banning multiple users at once, with a maximum of 20.
minute	Number	Yes	Ban duration in minutes. The maximum value is 43,200 minutes.

Request Example

POST /user/block.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=BWSZNmXBD&userId=jlk456j5&minute=10

Response Result

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}