Overview
Queries the sensitive words used to moderate the content of private-chat and group-chat text messages.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
GET
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/sensitivewords/list
Content-Type:
application/json
Request Example
GET /apigateway/sensitivewords/list?limit=20&offset=xx HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| offset | string | Yes | ID from which to begin the query. Each sensitive-word record has a unique ID. Leave this parameter empty for the initial query. | |
| limit | int | No | Number of records per page. Default: 50. Maximum: 100. |
Response Parameters
| Parameter | Data Type | Description | |
|---|---|---|---|
| items | array | List of sensitive words. | |
| items[].id | string | Unique ID of the sensitive word. | |
| items[].word | string | Sensitive word. | |
| items[].word_type | int | Filtering action. 1: block messages containing the sensitive word; 2: replace the sensitive word. | |
| is_finished | bool | Whether all records have been returned. |
Response Example
{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"id":"xx",
"word":"xx",
"word_type":1
}
],
"is_finished":false
}
}