自定义用户名单提交接口

2024.05.27 11:04:18

    接口说明

    通过该接口将自定义的用户名单抄送到易盾,命中名单后,产品可对数据做删除、隐藏处理。

    鉴权说明

    易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持 MD5,SHA1,SHA256,SM3 几种加密算法,详细信息,请参见接口鉴权

    请求

    请求地址

    名称
    HTTP URL https://as.dun.163yun.com/v2/list/submit
    HTTP Method POST

    请求头

    名称 类型 描述
    Content-Type String 固定值:"application/x-www-form-urlencoded"

    请求频率

    接口请求频率最快 10s/50 次请求。

    请求参数

    请求参数由公共参数和业务参数两部分组成。

    公共参数

    公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数

    业务参数

    名称 类型 是否必填 最大长度 描述
    version String 4 接口版本号,值为v2
    listType Integer 名单分类,1:白名单,2:黑名单,106:封禁名单
    entityType Integer 名单类型,1:用户名单,2:IP名单,3:设备名单,6:直播账号名单
    description String 1000 添加原因
    releaseTime Long 释放时间,设置此值表示名单到指定时间失效,单位为ms
    entities String 最多200条 名单列表,json字符串
    needConfirm Boolean 是否需要确认,默认false。false:不需要确认,直接覆盖;true:需要确认,当黑名单已存在时,添加白名单会给提示
    notCallback Boolean 是否不需要回调,默认false。false:需要回调;true:不需要回调
    spamType Integer 垃圾类型,0:正常,100:色情,200:广告,300:暴恐,400:违禁,500:涉政, 900:其他,1100:涉价值观

    请求体示例

    signature=signature&secretId=your_secret_id&businessId=your_businessId_id&nonce=16163&version=v2&timestamp=1574653947813&listType=2&entityType=1&description=test&releaseTime=1601540134000&entities=["用户黑名单1","用户黑名单2"]&needConfirm=alse&notCallback=false
    

    响应

    响应结果

    响应字段如下,响应公共字段已省略,详细见响应公共字段

    名称 类型 是否返回 描述
    result Object[] 提交返回结果
     ∟ uuid String 名单唯一标识,通常为32位长度由数字或者字母组成,用来删除、修改和查询
     ∟ entity String 添加时传入的名单值
     ∟ entityType Integer 名单类型,1:用户名单,2:IP名单,3:设备名单,6:直播账号名单
     ∟ exist Boolean 名单是否已存在,false:不存在;true:已存在

    响应示例

    {
        "code": 200,
        "msg": "ok",
        "result":[{
    		"uuid": "F9083114FBC0AA192A60B2AAFF43188C",
    		"entity":"123",
    		"entityType":"123",
    		"exist": false
    	}]
    }
    

    示例代码

    服务端 SDK 接入

    推荐使用我们提供的服务端 SDK 进行接入(目前支持 Java 和 Go 两种语言),不但可以节省接入成本,实现更快速的集成,并享有灵活的请求配置选项,同时 SDK 内置了错误重试、熔断降级等功能,提升服务可用性。点击 服务端 SDK 接入指引 了解更多。

    Github Demo 地址

    Gitee Demo 地址(Github 无法访问时选择)

    HTTP API 接入

    Github Demo 地址

    Gitee Demo 地址(Github 无法访问时选择)

    Online Chat Tel:95163223 Free trial