Get Chatroom Members

Retrieve the user IDs of members in a specified chatroom, with a maximum of 500 member details returned. Supports fetching in ascending or descending order based on join time.

Request Method

POST https://data center domain/chatroom/user/query.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 is formatted as 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
count	String	Yes	The number of chatroom member details to retrieve, up to 500
order	String	Yes	The order of joining the chatroom: 1 for ascending, 2 for descending

Request Example

POST /chatroom/user/query.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&count=2&order=1

Response

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

Return Value	Return Type	Description
code	Int	200: Success.
total	Int	The current number of users in the chatroom.
users	String[]	An array of chatroom members, up to 500.
id	String	User ID.
time	String	The time the user joined the chatroom. Accurate to the second, formatted as YYYY-MM-DD HH:MM:SS, e.g., 2022-09-25 16:12:38. Note: The value of time depends on the data center your app uses. For the China (Beijing) Data Center, time is in Beijing time. For the global data center, time is in UTC.

Response Example

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

{
  "code":200,
  "total":500,
  "users":[
  {
    "id":"uid1",
    "time":"2015-09-10 16:38:26"
  },
  {
    "id":"uid2",
    "time":"2015-09-10 16:38:26"
  }]
}