Check if a User is in a Chatroom

Check if a specified user is in a specified chatroom.

tip

Whether a user is in a chatroom may be affected by the chatroom's automatic exit mechanism.

Understand the Chatroom Automatic Exit Mechanism for Offline Members

The chatroom has an automatic exit mechanism for offline members. After a user goes offline, if the following default conditions are met, the IM service will automatically kick the user out of the chatroom:

• If the 31st message is generated within 30 seconds after the user goes offline, the automatic kick-out is triggered.
• Or, if a new message is generated in the chatroom after the user has been offline for 30 seconds, the automatic kick-out is triggered.

tip

• The default conditions require that new messages must be generated in the chatroom; otherwise, the kick-out action cannot be triggered. If no messages are generated in the chatroom, abnormal users cannot be kicked out.
• If you need to modify the default behavior's dependency on new messages, please submit a ticket to apply for Real-time Kick-out for Abnormal Chatroom Members. After enabling this service, the server will determine whether a user is in an abnormal state based on SDK behavior (requires Android/iOS IMLib SDK version ≧ 5.1.6, Web IMLib version ≧ 5.3.2), and the abnormal user will be kicked out within 5 minutes at the latest.
• To protect specific users, i.e., not automatically kicking out designated users (as some application scenarios may require users to stay in the chatroom), you can use the Chatroom User Whitelist function provided by the Server API.

Request Method

POST https://Data Center Domain/chatroom/user/exist.json

Rate Limit: 100 requests per second

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

Body Parameters

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

Parameter	Type	Required	Description
chatroomId	String	Yes	The ID of the chatroom to query
userId	String	Yes	The ID of the user to query

Request Example

POST /chatroom/user/exist.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

chatroomId=10001&userId=5

Response

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

Return Value	Return Type	Description
code	Int	200: Success.
isInChrm	Boolean	Whether the user is in the chatroom, true indicates the user is in the chatroom, false indicates the user is not in the chatroom.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200,"isInChrm":true}