更新时间: 2021-03-08
# 功能描述
1、融云文本消息的支持敏感词过滤、替换功能，敏感词替换支持单聊、群聊、聊天室会话，默认最多设置 50 个敏感词，设置 30 分钟后生效。
2、通过 Server API 发送的消息默认不支持敏感词过滤、替换，如果需要过滤敏感词功能，可在开发者后台免费基础功能 (opens new window)中开通。
3、目前支持的敏感词过滤语言包括：中文、英文、日语、德语、泰卢固文。
4、融云敏感词服务过滤规则如下：
支持对中文简体、繁体自动智能过滤。即：设置中文简体敏感词后，对应繁体敏感词也会自动识别过滤。
智能忽略标点符号，匹配敏感词功能。
敏感词中间含有标点符号时，会忽略中间的标点符号，对敏感词进行过滤，如：设置敏感词“反动”，当出现“反、动”中间含有标点符号的聊天信息时，会自动过滤。
英文、数字敏感词，支持全角、半角，大、小写自动匹配，对英文单词进行智能识别过滤功能。如：设置敏感词 “AV”，当出现含有 “Java” 的聊天信息时，因为 “Java” 为英文单词，所以不会对单词中包含的 “av” 进行过滤。
# 实现方法
# 添加敏感词
# 功能接口
请求地址： https://数据中心域名/sensitiveword/add.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| word | String | 是 | 敏感词，最长不超过 32 个字符，格式为汉字、数字、字母。 |
| replaceWord | String | 否 | 替换后的词，最长不超过 32 个字符。如未设置，当消息中含有敏感词时，消息将被屏蔽，用户不会收到消息。如设置了，当消息中含有敏感词时，将被替换为指定的词进行发送。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
# 代码示例
Request：
POST /sensitiveword/add.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded word=money&replaceWord=****已复制
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
2
3
4
# 移除敏感词
# 功能接口
请求地址： https://数据中心域名/sensitiveword/delete.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| word | String | 是 | 敏感词，最长不超过 32 个字符。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
# 代码示例
Request：
POST /sensitiveword/delete.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded word=money已复制
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
2
3
4
# 批量移除敏感词
# 功能接口
请求地址： https://数据中心域名/sensitiveword/batch/delete.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| words | String[] | 敏感词数组，一次最多移除 50 个敏感词。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
# 代码示例
Request：
POST /sensitiveword/batch/delete.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded words=money&words=aaa&words=bbb已复制
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
2
3
4
# 获取敏感词列表
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| type | String | 否 | 查询敏感词的类型，0 为查询替换敏感词，1 为查询屏蔽敏感词，2 为查询全部敏感词。默认为 1。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
| word | String | 敏感词内容。 |
| replaceWord | String | 替换敏感词的内容，为空时对应 Word 敏感词类型为屏蔽敏感词。 |
# 代码示例
请求地址： https://数据中心域名/sensitiveword/list.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
Request：
POST /sensitiveword/list.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded type=1已复制
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
2
3
4