Paginate group member information

This API retrieves paginated member information for specified groups, supporting sorting by role type and group join time.

Enabling the Service

Before using this feature, you must enable the profile hosting service by submitting a ticket.

Request method

POST: https://data center domain/entrust/group/member/query.json

Rate limit: 100 requests per second

Signature rules: All server API requests require signature verification. See API request signature for details.

Body parameters

The HTTP request body uses application/x-www-form-urlencoded format and supports these form parameters:

Parameter	Type	Required	Description
groupId	String	Yes	Group ID
type	Number	No	Member role type: 0: All members (default) returns all member types 1: Regular group member 2: Group administrator 3: Group owner
pageToken	String	No	Pagination token from previous response. Omit for first request.
size	Number	No	Items per page: Default 50, maximum 100.
order	Number	No	Sort order by join time: 0: Ascending 1: Descending (default)

Request example

POST /entrust/group/member/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

groupId=groupId1

Response

The HTTP response body contains a JSON object with this structure:

Field	Type	Description
code	Number	Status code (200 indicates success)
totalCount	Number	Total group members
pageToken	String	Pagination token for next request (when more results exist)
members	JSONArray	Member information list
members structure
members[i].userId	String	Member user ID
members[i].nickname	String	Member's group alias
members[i].role	String	Member role (1: Regular member, 2: Administrator, 3: Group owner)
members[i].time	String	Group join timestamp
members[i].extra	String	Member extended information

Response example

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

{
    "code": 200,
    "totalCount": 40,
    "pageToken": "XXXXX",
    "groupId": "groupId",
    "members": [
        {
            "userId": "u01",
            "role":1,
            "nickname": "nickname1",
            "time":12343433499942
        },
        {
            "userId": "u02",
            "nickname": "nickname2",
            "time":12343433499943,
            "role":3,
            "extra": "xxxx"
        }
    ]
}