Query banned users

Retrieve the list of banned users, including user IDs and ban expiration times.

Bans are automatically lifted when the duration expires. You can also manually unban users.

Request method

POST: https://Base URL/v4/user/ban/list

Rate limit: 100 requests per second

Signature required: All server API requests require signature verification. See API request signature.

Request body

The request body is in application/json format and supports the following parameters:

Parameter	Type	Required	Description
page	Number	No	Page number. If not provided, returns the first 1,000 banned users sorted by ban expiration time in descending order.
pageSize	Number	No	Items per page. Defaults to 50.

Request example

HTTP

POST /v4/user/ban/list HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: xxxxxxxxxxxxxxxx
Content-Type: application/json

{
    "page": 1,
    "pageSize": 50
}

Response

Field	Type	Description
code	Number	Status code. 0 indicates success.
result	Object	Response data.
result.bannedUsers	Array	List of banned users.
result.bannedUsers[i].userId	String	The banned user's ID.
result.bannedUsers[i].banExpiresAt	String	Ban expiration time.

Response example

HTTP

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

{
    "code": 0,
    "result": {
        "bannedUsers": [
            {
                "userId": "jlk456j5",
                "banExpiresAt": "2015-01-11 01:28:20"
            }
        ]
    }
}