Add Sensitive Words
Text messages support sensitive word filtering and replacement, which is applicable to one-to-one chat, group chat, chatroom, and ultra group conversations. By default, you can set up to 50 sensitive words, and additional words can be purchased in the Console. The settings take effect after 15 minutes.
Currently supported languages for sensitive word filtering include: Chinese, English, Japanese, German, Russian, Korean, and Arabic.
For more details, refer to the Sensitive Word Filtering Rules section in the Content Moderation Overview.
Enable the Service
The IM service has a built-in sensitive word mechanism, so no additional activation is required. Note that the sensitive word mechanism is only effective for messages sent by the client by default, and not for messages sent via the IM Server API. If needed, enable Server API Message Filtering for Sensitive Words. For more information, see Configure Sensitive Word Service.
Request Method
POST: https://data center domain/sensitiveword/add.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests require signature validation. For details, refer to API Request Signature.
Request Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| word | String | Yes | Sensitive word, up to 32 characters, including Chinese characters, numbers, and letters. |
| replaceWord | String | No | Replacement word, up to 32 characters. If not set, messages containing sensitive words will be blocked, and users won't receive them. If set, messages containing sensitive words will be replaced with the specified word before being sent. |
Request Example
POST /sensitiveword/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
word=money&replaceWord=****
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Type | Description |
|---|---|---|
| code | Number | Return code, 200 indicates success. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}