跳转至

敏感词

功能概述

默认最多设置 50 个敏感词,设置后 2 小时内生效,目前只支持融云内置消息类型文本消息的敏感词过滤、替换功能,通过 Server API 发送的消息默认不支持敏感词过滤、替换,如果需要过滤敏感词请提交工单申请开通。

详细请查看屏蔽包含敏感词的消息与替换敏感词功能说明

添加敏感词

方法名:/sensitiveword/add

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/sensitiveword/add.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
word String 敏感词,最长不超过 32 个字符,格式为汉字、数字、字母。(必传)
replaceWord String 需要替换的敏感词,最长不超过 32 个字符,(非必传)。如未设置替换的敏感词,当消息中含有敏感词时,消息将被屏蔽,用户不会收到消息。如设置了替换敏感词,当消息中含有敏感词时,将被替换为指定的字符进行发送。敏感词替换目前只支持单聊、群聊、聊天室会话。

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

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=****

HTTP 响应:

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

{"code":200}

提示

融云敏感词服务过滤规则如下:

1、支持对中文简体、繁体自动智能过滤。即:设置中文简体敏感词后,对应繁体敏感词也会自动识别过滤。

2、智能忽略标点符号,匹配敏感词功能。

敏感词中间含有标点符号时,会忽略中间的标点符号,对敏感词进行过滤,如:设置敏感词“反动”,当出现“反、动”中间含有标点符号的聊天信息时,会自动过滤。

3、英文、数字敏感词,支持全角、半角,大、小写自动匹配,对英文单词进行智能识别过滤功能。如:设置敏感词 “AV”,当出现含有 “Java” 的聊天信息时,因为 “Java” 为英文单词,所以不会对单词中包含的 “av” 进行过滤。

4、Server API 发送的消息默认不走敏感词过滤,如需要过滤敏感词可提交工单申请。

移除敏感词

说明:从敏感词列表中,移除某一敏感词,移除后 2 小时内生效。

方法名:/sensitiveword/delete

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/sensitiveword/delete.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
word String 敏感词,最长不超过 32 个字符。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

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

HTTP 响应:

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

{"code":200}

批量移除敏感词

说明:从敏感词列表中,批量移除某些敏感词,一次最多移除敏感词不超过 50 个,移除后 2 小时内生效。

方法名:/sensitiveword/batch/delete

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/sensitiveword/batch/delete.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
words String[] 敏感词数组,一次最多移除 50 个敏感词。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

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

HTTP 响应:

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

{"code":200}

获取敏感词列表

方法名:/sensitiveword/list

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/sensitiveword/list.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
type String 查询敏感词的类型,0 为查询替换敏感词,1 为查询屏蔽敏感词,2 为查询全部敏感词。默认为 1。(非必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。
word String 敏感词内容。
replaceWord String 替换敏感词的内容,为空时对应 Word 敏感词类型为屏蔽敏感词。

JSON 格式:

{
  "code":200,
  "words":[{
    "type":"0",
    "word":"黄赌毒",
    "replaceWord":"***"
  },
  {
    "type":"1",
    "word":"qqq",
    "replaceWord":""
  }]
}

返回值请参考 API 方法返回值说明

获取屏蔽敏感词示例

HTTP 请求:

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

HTTP 响应:

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

{"code":200,"words":[{"word":"环保"},{"word":"承诺"}]}

获取替换敏感词示例

HTTP 请求:

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=0

HTTP 响应:

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

{
  "code":200,
  "words":[{
    "type":"0",
    "word":"黄赌毒",
    "replaceWord":"***"
  },{
    "type":"0",
    "word":"qqq",
    "replaceWord":"ddd"
  }]
}

获取全部敏感词示例

HTTP 请求:

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=2

HTTP 响应:

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

{
  "code":200,
  "words":[{
    "type":"0",
    "word":"黄赌毒",
    "replaceWord":"***"
  },{
    "type":"1",
    "word":"qqq",
    "replaceWord":""
  }]
}