Query User's Joined Groups

Query all groups that a user has joined based on their user ID, returning the group ID and group name. By default, it retrieves a list of the first 5000 groups the user has joined.

tip

The IM Service does not store group profile information. It is recommended that developers maintain group profiles and member information on their application servers. If there are discrepancies in the user-group relationships maintained by the application server, this interface can be used for verification.

Request Method

POST: https://Data Center Domain/user/group/query.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests must undergo rule validation. For details, see API Request Signature.

Body Parameters

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

Parameter	Type	Required	Description
userId	String	Yes	User ID.
page	Int	No	Current page number, used for paginated queries. If pagination is required, the default page size is 50, which can be adjusted using the size parameter. If pagination is not needed, this parameter can be omitted (or set to 0), and the first 5000 groups the user has joined will be returned.
size	Int	No	Page size, only effective when page is provided. The default is 50 entries per page, with a maximum of 1000.

Request Example

POST /user/group/query.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=123

Response

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

Return Value	Type	Description
code	Int	Return code, 200 indicates success.
groups	String	An array of groups the user has joined.
name	String	Group name.
id	String	Group ID.

Response Example

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

{
  "code":200,
  "groups":[
  {
    "name":"GroupName_1",
    "id":"GroupId_1"
  },
  {
    "name":"GroupName_8",
    "id":"GroupId_8"
  }]
}