Overview
Query the users that a specified user is not allowed to message privately. 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/blockusers/query
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| user_id | string | Yes | ID of the user whose private-message restrictions are queried. Maximum length: 32 characters. | |
| limit | int | No | Number of records per page. | |
| offset | string | No | Pagination offset. |
Request Example
GET /apigateway/users/blockusers/query?user_id=user1&limit=20&offset="" HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
Response Parameters
| Parameter | Data Type | Description | |
|---|---|---|---|
| user_id | string | ID of the user whose private-message restrictions were queried. | |
| items | array | List of users that the specified user is not allowed to message. | |
| items[].block_user_id | string | ID of a restricted recipient. | |
| items[].created_time | number | Time when the restriction was added. | |
| offset | string | Offset for the next page. |
Response Example
{
"code":0,
"msg":"sucess",
"data":{
"user_id":"user1",
"items":[
{
"block_user_id":"user2",
"created_time":1672233498000
},
{
"block_user_id":"user3",
"created_time":1672233498000
}
],
"offset":"aaddcxx"
}
}