Query allowlist user list

Query the allowlist user list of a specified user. Only users in the allowlist can send messages to the current user.

Before using this API, ensure that the allowlist service is enabled. For details, refer to Allowlist Service Overview.

Request Method

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

Signature Rule: All server API requests require signature verification. For details, refer to API Request Signature.

Rate Limit: 100 requests per second

Body Parameters

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

Parameter	Type	Required	Description
userId	String	Yes	User ID.
pageToken	String	No	Pagination token, taken from the next parameter returned in the previous request. If not provided, no pagination is applied, and the first 1000 users are returned by default, sorted in reverse order by the time they were added to the allowlist.
size	Int	No	Number of users per page when paginating the allowlist. If not provided, the default is 1000, with a maximum of 1000.

Request Example

POST /user/whitelist/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=jlk456j5&pageToken=COIB&size=10

Response

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

Return Value	Return Type	Description
code	Int	Return code, 200 indicates success.
users	String[]	Array of allowlist users.
next	String	Pagination token, returned if there is a next page, to be passed in the next request.

Response Example

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

{
    "code": 200,
    "next": "CNgB",
    "users": [
        "uid20",
        "uid19",
        "uid18",
        "uid17",
        "uid16",
        "uid15",
        "uid14",
        "uid13",
        "uid12",
        "uid11"
    ]
}