API Overview
Message Callbacks
Status Codes
Overview
Adds 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:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/sensitivewords/add
Content-Type:
application/json
Request Example
POST /apigateway/sensitivewords/add HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"items":[
{
"word":"xxxxx",
"word_type":1
}
]
}
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| items | array | Yes | List of sensitive words to add. | |
| items[].word | string | Yes | Sensitive word. Maximum length: 255 characters. | |
| items[].word_type | int | Yes | Filtering action. 1: block messages containing the sensitive word; 2: replace the sensitive word. |
Response Example
{
"code":0,
"msg":"sucess"
}