名单库查询接口

2024.06.20 14:06:52

    接口说明

    本接口用于名单库内容查询。

    鉴权说明

    易盾智能风控服务使用签名认证方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5签名算法,详细信息请参见接口鉴权

    接入须知

    控制接口调用频率,频率过快可能会被拒绝,拒绝后稍后重试即可。

     

    名单查询接口请求说明

    请求地址

    名称
    HTTP URL http://ir-open.dun.163.com/v5/list/query
    HTTP Method POST

    请求头

    名称 类型 必填 描述
    Content-Type String 固定值:"Content-Type:application/json"

    请求参数

    请求参数分为:公共参数,接口参数。其中,公共参数请见公共请求参数;接口参数如下:

    参数 类型 必填 描述
    listGroupCode String 名单库编号
    pageNum Integer 该参数为分页参数中的当前页数(第一页为1),配合每页数据条数(默认为50无需传入)使用。
    返回值中count代表的记录总条数超出时,可使用分页查询获取所有数据。
    beginModifyTime Long (起)更新时间
    endModifyTime Long (止)更新时间

    请求参数示例

    {
        "businessId": "xxx966f73yyy59440583zzz9bfcc79df",
        "secretId": "nnn966f73yyy59440583zzz9bfcc79dc",
        "timestamp": ${currentTimeMs},
        "nonce": "mmm888f73yyy59440583zzz9bfcc79de",
        "version": "500",
        "signature": "lll888f73yyy59440583zzz9bfcc79da",
        "listGroupCode": "xxx",
        "pageNum": 1,
        "beginModifyTime": 1722752003000,
        "endModifyTime": 1722752006000
    }
    
    

    响应

    响应结果

    响应数据格式为:JSON。

    响应头为:Content-Type:application/json,具体如下:

    参数 类型 描述
    code Integer 响应码,正常情况下为200,异常时,见 附录响应码定义
    msg String 响应码说明,正常情况下返回“ok”,异常时,见 附录响应码定义
    data JSONObject 返回data数据,格式下表说明

    返回data数据的格式:

    参数 类型 说明
    count Long 记录总条数
    rows Array 明细数据内容列表,格式下表说明

    返回明细数据的格式:

    参数 类型 说明
    listGroupCode String 名单库编号
    content String 名单项内容
    expireTime Long 释放时间
    description String 添加原因
    hitCount Long 命中次数
    status Integer 名单状态,0-失效 1-生效
    createTime Long 创建时间
    modifyTime Long 更新时间
    createBy String 创建人

    响应结果示例

    {
            "code": 200,
            "msg": "成功",
            "data": {
                "count": 100,
                "rows": [
                {
                    "listGroupCode": "L20240004110501",
                    "content": "xxx001",
                    "expireTime": 1710245850202,
                    "description": "xx原因",
                    "hitCount": 10,
                    "status": 1,
                    "createTime": 1709709416661,
                    "modifyTime": 1709709416661,
                    "createBy": "openApi"
                },
                {
                    "listGroupCode": "L20240004110501",
                    "content": "xxx002",
                    "expireTime": 1804317907073,
                    "description": "xx一键添加",
                    "hitCount": 20,
                    "status": 1,
                    "createTime": 1709709907287,
                    "modifyTime": 1709709907287,
                    "createBy": "system"
                }
                ]
            },
            "ok": true
            }
    
    

    响应返回码

    响应返回码见:响应返回码

    接入示例代码

    服务端 SDK 接入

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

    Github Demo 地址

    Online Chat Tel:95163223 Free trial