自定义忽略词修改接口
2024.11.21 16:52:07
接口说明
通过该接口可以修改已抄送的自定义忽略词信息,易盾会同步刷新修改后信息
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权
接口要求
- 单次提交只能修改1个词
接口耗时
自定义忽略词修改接口建议超时时间1s
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | http://as.dun.163.com/v1/pretreatment/update |
HTTP Method | POST |
请求头
名称 | 类型 | 描述 |
---|---|---|
Content-Type | String | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数
业务参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
version | String | 是 | 4 | 接口版本号,可选值v1 |
description | String | 否 | 128 | 添加描述 |
id | Number | 是 | 2^63-1 | 忽略词id |
entity | String | 是 | 128 | 忽略词内容 |
请求体示例
entity=忽略词1&id=163&version=v1&description=忽略词修改&signature=xxx&secretId=xxx&businessId=xxx&nonce=420797907×tamp=1662011841562
响应
响应结果
响应字段如下,响应通用字段已省略,详细见响应公共字段:
名称 | 类型 | 是否返回 | 描述 |
---|---|---|---|
result | Boolean | 是 | 响应结果 |
响应体示例
{
"code": 200,
"msg": "ok",
"result": true
}
响应返回码
响应返回码见:响应返回码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入(目前支持 Java 和 Go 两种语言),不但可以节省接入成本,实现更快速的集成,并享有灵活的请求配置选项,同时 SDK 内置了错误重试、熔断降级等功能,提升服务可用性。点击 服务端 SDK 接入指引 了解更多。