跳到主要内容

批量添加消息敏感词

文本消息支持敏感词过滤、替换功能，敏感词替换支持单聊、群聊、聊天室、超级群会话，默认最多设置 50 个敏感词，设置 15 分钟后生效。

目前支持的敏感词过滤语言包括：中文、英文、日语、德语、俄语、韩语、阿拉伯语。

详见内容审核能力概述中的敏感词过滤规则。

开通服务​

即时通讯服务内置敏感词机制，无需开通。注意，敏感词机制默认仅对客户端发送的消息生效，不对通过即时通讯服务端 API 发送的消息生效。如有需要，请开启 Server API 发送消息过滤敏感词。详见配置敏感词服务配置。

请求方法​

POST： https://数据中心域名/sensitiveword/batch/add.json

调用频率：每秒钟限 100 次

签名规则：所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/json，包含具有以下结构的 JSON 对象：

参数类型必传说明
wordsArray是默认最多可设置 50 个敏感词，超出上限后本次设置全部失败，返回错误码同时返回剩余可设置的敏感词数量：
words[i].wordString是敏感词，最长不超过 32 个字符。
words[i].replaceWordString否替换后的词，最长不超过 32 个字符。如未设置，当消息中含有敏感词时，消息将被屏蔽，用户不会收到消息。如设置了，当消息中含有敏感词时，将被替换为指定的词进行发送。

请求示例​

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": "替换",
            "replaceWord": "替换后"
        },{
            "word": "屏蔽"
        }
    ]
}

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。
remainQuotaNumber剩余可设置的敏感词数量。

返回结果示例​

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
}
最后于 更新