自定义用户名单更新接口
2024.09.27 11:14:17
接口说明
通过该接口可以修改已抄送的自定义用户名单状态信息,易盾会同步刷新信息。
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | https://as.dun.163yun.com/v2/list/update |
HTTP Method | POST |
请求头
名称 | 类型 | 描述 |
---|---|---|
Content-Type | String | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成。
公共参数
公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数
业务参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
version | String | 是 | 接口版本号,值为v2 |
uuid | String | 是 | uuid和entity传一个即可,名单唯一标识,通常为32位长度由数字或者字母组成,用来删除、修改和查询 |
entity | String | 是 | 添加时传入的名单值 |
listType | Integer | 是 | 名单分类,1:白名单,2:黑名单,106:封禁名单 |
entityType | Integer | 是 | 名单类型,1:用户名单,2:IP名单,3:设备名单,6:直播账号名单 |
status | Integer | 是 | 名单状态:0:失效,1:生效 |
notCallback | Boolean | 否 | 是否不需要回调,默认false。False:需要回调;true:不需要回调 |
releaseTime | Long | 否 | 释放时间,设置此值表示名单到指定时间失效,单位为ms |
spamType | Integer | 否 | 垃圾类型,0:正常,100:色情,200:广告,300:暴恐,400:违禁,500:涉政,900:其他,1100:涉价值观 |
请求体示例
signature=signature&secretId=your_secret_id&businessId=your_businessId_id&nonce=16163&version=v2×tamp=1574653947813&listType=1&entityType=1&uuid=F9083114FBC0AA192A60B2AAFF43188C&status=0¬Callback=false&releaseTime=1601540134000&spamType=900
响应
响应结果
名称 | 类型 | 是否返回 | 描述 |
---|---|---|---|
code | Integer | 是 | 返回错误码,取值见官网公共返回错误码定义 |
msg | String | 是 | 返回错误消息 |
result | Boolean | 是 | 提交返回结果 |
响应示例
{
"code": 200,
"msg": "ok",
"result": true
}
示例代码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入(目前支持 Java 和 Go 两种语言),不但可以节省接入成本,实现更快速的集成,并享有灵活的请求配置选项,同时 SDK 内置了错误重试、熔断降级等功能,提升服务可用性。点击 服务端 SDK 接入指引 了解更多。