自定义关键词添加接口
2024.04.17 11:53:52
接口说明
通过该接口将自定义的关键词抄送到易盾，命中关键词后默认返回不通过，产品可对数据做删除隐藏处理
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权
接口要求
- 单次添加不超过200个词
- 单次提交只能指定一种关键词类型提交，不支持混合提交，例如提交组合词，需要全部提交组合词类型
- 拼音关键词添加，选择关键词类型：拼音词，格式仅支持中文填写，中文长度必须大于1
- 组合关键词添加，选择关键词类型：普通组合词，添加格式：(关键词1+关键词2+关键词3...)，多个词同时出现时会命中，组合关键词个数限制为2-5个，其中关键词格式支持 纯中文/纯英文字母/纯数字或中文、英文字母与数字任意组合，关键词之间不允许重复
接口耗时
自定义关键词添加接口建议超时时间1s
请求
请求地址
| 名称 | 值 |
|---|---|
| HTTP URL | http://as.dun.163.com/v1/keyword/submit |
| HTTP Method | POST |
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| Content-Type | String | 固定值："application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数
业务参数
| 名称 | 类型 | 是否必传 | 最大长度 | 描述 |
|---|---|---|---|---|
| version | String | 是 | 4 | 接口版本号，可选值v1 |
| category | Number | 是 | 4 | 关键词返回的垃圾分类，100：色情，200：广告，260：广告法，300：暴恐，400：违禁，500：涉政，600：谩骂，700：灌水，1100：涉价值观 |
| subLabel | String | 是 | 16 | 细分类，详细编码请参考下方对应细分类编码对照表 |
| keywords | String | 是 | 200条/次，128位/条 | 关键词检测列表 |
| level | Number | 是 | 4 | 关键词等级，1：嫌疑，2：不通过 |
| type | Number | 是 | 4 | 关键词类型，1：普通词，2：组合词，3：拼音词 |
| dataTypes | Number | 否 | 4 | 子数据类型，用于区分过滤标注完全一致的不同模块数据，与易盾内容安全服务约定即可 |
| releaseTime | Long | 否 | 13 | 失效时间，设置此值表示名单到指定时间失效，时间戳单位为ms |
| sceneName | String | 否 | 32 | 产品业务组名称，不为空时关键词将被添加到该产品业务组下 |
请求体示例
keywords=色情敏感词6,色情敏感词5&signature=c855fbdcb8efa0cc44fafc435708a9a7&businessId=xxxxxxx&secretId=xxxxxxxx&signatureMethod=MD5&category=100&version=v1&nonce=-427093960×tamp=1662011085201&subLabel=100&level=2&type=1
响应
响应结果
响应字段如下，响应通用字段已省略，详细见响应公共字段：
| 名称 | 类型 | 是否返回 | 描述 |
|---|---|---|---|
| result | Object[] | 是 | 响应结果 |
| ∟ keyword | String | 是 | 提交的关键词内容 |
| ∟ id | Number | 是 | 提交的关键词id |
响应体示例
{
"code": 200,
"msg": "ok",
"result": [
{
keyword: "(色情关键词1+色情关键词2+色情关键词3)",
id: 163
}
]
}
响应返回码
响应返回码见：响应返回码
示例代码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入（目前支持 Java 和 Go 两种语言），不但可以节省接入成本，实现更快速的集成，并享有灵活的请求配置选项，同时 SDK 内置了错误重试、熔断降级等功能，提升服务可用性。点击 服务端 SDK 接入指引 了解更多。
