自定义忽略词查询接口

2022.09.21 09:38:54

    易盾内容安全自定义忽略词接口可以根据场景需要自定义调整过滤策略

    接口说明

    通过该接口可以查询已抄送的自定义忽略词信息

    鉴权说明

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

    接口要求

    • 接口需要分页查询

    接口耗时

    自定义忽略词查询接口建议超时时间1s

    请求

    请求地址

    名称
    HTTP URL http://as.dun.163.com/v1/pretreatment/pageQuery
    HTTP Method POST

    请求头

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

    请求参数

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

    公共参数

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

    业务参数

    名称 类型 必填 最大长度 描述
    version String 4 接口版本号,可选值 v1
    id Number 2^63-1 忽略词id
    entity String 128 忽略词内容
    startTime Number 13 开始时间,毫秒单位,时间戳
    endTime Number 13 结束时间,毫秒单位,时间戳
    pageNum Number 4 分页标号,从1开始,如果传4代表从第4页返回内容
    pageSize Number 4 分页大小

    请求体示例

    version=v1&startTime=1000000000000&endTime=1234567891011&pageNum=1&pageSize=20&signature=xxx&secretId=xxx&businessId=xxx&nonce=420797907&timestamp=1662011841562
    

    响应

    响应结果

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

    名称 类型 必填 描述
    result Object 响应结果
     ∟ count Long 数据总量
     ∟ rows Object[] 分页数据
      ∟ id Number 忽略词id
      ∟ entity String 忽略词内容
      ∟ entityType Number 1:忽略词
      ∟ source Number 忽略词添加来源 1:用户添加
      ∟ creator String 创建账号
      ∟ productId Number 产品id
      ∟ targetId Number 业务id
      ∟ insertTime Number 忽略词插入时间
      ∟ lastModifyTime Number 最近一次修改时间

    响应体示例

    {
        "code": 200,
        "msg": "ok",
        "result": {
            "count": 1,
            "rows": [
                {
                    "id": 127008,
                    "productId": 18375,
                    "targetId": 19008,
                    "entityType": 1,
                    "entity": "entity",
                    "lastModifyTime": 1599185739743,
                    "insertTime": 1599184967534,
                    "source": 1,
                    "creator": "na_pretreatmentlist@163.com",
                    "lastOperator": "na_pretreatmentlist@163.com",
                    "description": "0"
                }
            ]
        }
    }
    

    响应返回码

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

    SDK接入方法

    为方便 JAVA 开发者调试和接入API,我们提供了配套的开发工具集(SDK),用于简化API接入流程。SDK中各接口调用方式基本相同,接入方式统一,并提供了一些接口调用过程中常见的异常处理方案。以下介绍了SDK的使用流程,以及首次使用SDK的简单示例。

    如果您使用的是其他语言,请参考各语言示例demo

    • 准备工作

    准备步骤详见通用步骤

    • 使用方法

    使用方法可参考使用SDK

    Online Chat Tel:95163223