Paginated Retrieval of All Application Users

Retrieve a list of all application users hosted on RC servers, with results displayed in paginated format.

Enable the Service

Before calling this API, enable the profile hosting service by submitting a ticket.

Request Method

POST: https://data center domain/user/profile/query.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature verification. See API Request Signature for details.

Request Parameters

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

Parameter	Type	Required	Description
page	Number	No	Default: 1
size	Number	No	Default: 20, Max: 100
order	Number	No	Sorting by registration time. Default ascending (0=ascending, 1=descending)

Request Example

POST /user/profile/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

page=1&count=30&order=1

Response

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

Field	Type	Description
code	Number	Status code (200 indicates success)
userList	JSONArray	User list information
userList structure

The userList structure contains:

Field	Type	Description
userList[i].userId	String	User ID
userList[i].userProfile	String	Basic user information (JSON data)
userList[i].userExtProfile	String	Extended user information (JSON data)

The userProfile contains the following keys:

Key	Type	Length/Range	Description
uniqueId	String	Max 32 chars	Application user ID
name	String	Max 32 chars	Nickname
portraitUri	String	Max 128 chars	Avatar URL
email	String	Max 128 chars	Email address
birthday	String	Max 32 chars	Birthday
gender	Int	Values: 0: Unknown 1: Male 2: Female	Gender
location	String	Max 32 chars	Location
role	Int	0-100	Role
level	Int	0-100	Level

Response Example

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

{
    "code": 200,
    "userList": [
        {
            "userId": "u01",
            "userProfile": {"appName":"testAppName","level":2},
            "userExtProfile": {"ext_Profile":"testExt"}
        }
    ]
}