自定义用户名单查询接口

2024.05.27 11:04:18

    接口说明

    通过该接口可以查询已抄送的自定义用户名单信息。

    鉴权说明

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

    请求

    请求地址

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

    请求头

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

    请求参数

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

    公共参数

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

    业务参数

    名称 类型 是否必填 描述
    version String 接口版本号,值为v2
    listType Integer 名单分类,1: 白名单,2: 黑名单
    entityType Integer 名单类型,1: 用户名单,2: IP名单,3: 设备名单
    pageNum Integer 页数
    pageSize Integer 每页大小
    startTime Long 开始时间
    endTime Long 结束时间
    source Integer 名单添加来源,0:后台添加,1:用户名单配置,2:用户审核添加,3:内容审核添加
    entity String 添加时传入的名单值
    status Integer 名单状态,0:失效,1: 生效
    orderType Integer 排序类型,0:插入时间降序,1:插入时间升序,2:命中数量升序,3:命中数量降序
    uuid String 名单唯一标识,通常为32位长度由数字或者字母组成,用来删除修改和查询
    spamType Integer 垃圾类型,0:正常,100:色情,200:广告,300:暴恐,400:违禁,500:涉政,900:其他,1100:涉价值观

    请求体示例

    signature=signature&secretId=your_secret_id&businessId=your_businessId_id&nonce=16163&timestamp=1574653947813&version=v2&pageNum=1&pageSize=10&startTime=1574653947813&endTime=1584653947813&listType=2&entityType=1
    

    响应

    响应结果

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

    名称 类型 是否返回 描述
    result Object[] 提交返回结果
     ∟ count Long 查询总数量
     ∟ rows Object[] 查询列表
      ∟ listType Integer 名单分类,1: 白名单,2: 黑名单
      ∟ entityType Integer 名单类型,1: 用户名单,2: IP名单,3: 设备名单
      ∟ uuid String 名单唯一标识,通常为32位长度由数字或者字母组成,用来删除修改和查询
      ∟ productId Long 产品id
      ∟ targetId Long 业务id
      ∟ entity String 添加时传入的名单值
      ∟ description String 添加原因
      ∟ releaseTime Long 释放时间,设置此值表示名单到指定时间失效,单位为ms
      ∟ insertTime Long 插入时间和更新时间,单位为ms
      ∟ operator String 操作人
      ∟ ext String 扩展字段
      ∟ spamType Integer 垃圾类型,0:正常,100:色情,200:广告,300:暴恐,400:违禁,500:涉政,900:其他,1100:涉价值观
      ∟ source Integer 名单添加来源,0:后台添加,1:用户名单配置,2:用户审核添加,3:内容审核添加
      ∟ hitCount Long 命中个数
      ∟ status Integer 名单状态,0:失效,1:生效

    响应体示例

    {
        "code": 200,
        "msg": "ok",
        "result":{
    		"count": 10,
    		"rows": [{
    			"listType": 1,
    			"entityType": 1,
    		        "uuid": "F9083114FBC0AA192A60B2AAFF43188C",
    			"productId": 123,
    			"targetId": 123,
    			"entity": "111",
    	                "description": "description",
    			"releaseTime": 1574653947813,
                            "insertTime": 1574653947810,
                            "operator": "operator",
                            "ext": "test",
    			"source": 0,
    			"spamType": 900,
    			"hitCount": 3,		
    			"status": 1
    		}]
    	}
    }
    

    示例代码

    服务端 SDK 接入

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

    Github Demo 地址

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

    HTTP API 接入

    Github Demo 地址

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

    Online Chat Tel:95163223 Free trial