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