Batch Query User Presence in Chatroom

Batch query whether users are in a specified chatroom, with a maximum of 1000 users per query.

tip

The presence of users in the chatroom may be affected by the chatroom's automatic exit mechanism.

Understanding the Chatroom Offline Member Auto-Exit Mechanism

The chatroom has an automatic exit mechanism for offline members. If a user goes offline and meets the following default conditions, the IM service will automatically kick the user out of the chatroom:

• Within 30 seconds of the user going offline, if the 31st message is generated in the chatroom, the auto-kick is triggered.
• Or, if the user has been offline for 30 seconds and a new message is generated in the chatroom, the auto-kick is triggered.

tip

• The default conditions require that new messages must be generated in the chatroom; otherwise, the kick action cannot be triggered. If no messages are generated in the chatroom, abnormal users cannot be kicked out.
• To modify the default behavior's dependency on new messages, submit a ticket to enable Real-Time Kick for Abnormal Chatroom Members. Once enabled, the server will determine the user's abnormal status based on SDK behavior (requires Android/iOS IMLib SDK version ≧ 5.1.6, Web IMLib version ≧ 5.3.2), and abnormal users will be kicked out within 5 minutes at the latest.
• To protect specific users from being automatically kicked out (e.g., in certain scenarios where users need to stay in the chatroom), use the Chatroom User Whitelist feature provided by the Server API.

Request Method

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

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature validation. For details, see 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
chatroomId	String	Yes	The ID of the chatroom to query
userId	String	Yes	The user ID to query, up to 1000 user IDs per request

Request Example

POST /chatroom/users/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=y41z2IXBW&userId=niCtlxnas

Response

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

Return Value	Return Type	Description
code	Int	200: Success.
userid	String	The user ID in the chatroom.
isInChrm	Int	Whether the user is in the chatroom, 1 for yes, 0 for no.

Response Example

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

{
  "code":200,
  "result":[
     {"userid":"y41z2IXBW", "isInChrm":0},
     {"userid":"niCtlxnas", "isInChrm":1}
   ]
}