Batch Add Sensitive Words

Text messages support sensitive word filtering and replacement. The sensitive word replacement feature is available for one-to-one chat, group chat, chatroom, and ultra group conversations. By default, you can set up to 50 sensitive words, and 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 comes with 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 does not apply to messages sent via the IM server API. If needed, enable Server API Message Filtering for Sensitive Words. For more details, see Configure Sensitive Word Service Settings.

Request Method

POST: https://Data Center Domain/sensitiveword/batch/add.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature validation. For more details, see API Request Signature.

Request Body Parameters

The HTTP request body is in application/json format and contains a JSON object with the following structure:

Parameter	Type	Required	Description
words	Array	Yes	By default, you can set up to 50 sensitive words. Exceeding this limit will cause the entire batch to fail, returning an error code along with the remaining quota for sensitive words.
words[i].word	String	Yes	The sensitive word, with a maximum length of 32 characters.
words[i].replaceWord	String	No	The replacement word, with a maximum length of 32 characters. If not set, messages containing sensitive words will be blocked, and users will not receive them. If set, messages containing sensitive words will be replaced with the specified word before being sent.

Request Example

POST /sensitiveword/batch/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json; charset=utf-8

{
  "words": [
        {
            "word": "replace",
            "replaceWord": "replaced"
        },{
            "word": "block"
        }
    ]
}

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Type	Description
code	Number	The return code, where 200 indicates success.
remainQuota	Number	The remaining quota for sensitive words.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

HTTP/1.1 429 Too Many Requests
Content-Type: application/json; charset=utf-8

{
    "code": 1019,
    "errorMessage": "The number of sensitive words exceeds the limit.",
    "url": " /sensitiveword/batch/add.json",
    "remainQuota": 1
}