Overview
Query the list of banned users. Pagination is supported.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
GET
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/users/banusers/query
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| limit | int | No | Number of records per page. Default: 50. Maximum: 100. | |
| offset | string | No | Pagination offset. |
Request Example
GET /apigateway/users/banusers/query?limit=20&offset="" HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
Response Parameters
| Parameter | Data Type | Description | |
|---|---|---|---|
| items | array | List of banned users. | |
| items[].user_id | string | Banned user ID. | |
| items[].created_time | number | Time when the ban was added. | |
| items[].end_time | number | Ban expiration time in milliseconds. A value of 0 indicates a permanent ban. | |
| offset | string | Offset for the next page. |
Response Example
{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"user1",
"created_time":1672233498000
},
{
"user_id":"user2",
"created_time":1672233498000,
"end_time":1723455443563
}
],
"offset":"aabbcc"
}
}