自定义用户名单更新接口

2024.01.29 19:25:36

    接口说明

    通过该接口可以修改已抄送的自定义用户名单状态信息,易盾会同步刷新信息。

    鉴权说明

    易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(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&timestamp=1574653947813&listType=1&entityType=1&uuid=F9083114FBC0AA192A60B2AAFF43188C&status=0&notCallback=false&releaseTime=1601540134000&spamType=900
    

    响应

    响应结果

    名称 类型 是否返回 描述
    code Integer 返回错误码,取值见官网公共返回错误码定义
    msg String 返回错误消息
    result Boolean 提交返回结果

    响应示例

    {
        "code": 200,
        "msg": "ok",
        "result": true
    }
    

    接入示例代码

    开发工具集(SDK)接入

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

    • 准备工作

    准备步骤详见通用步骤

    • 使用方法

    该接口的使用方法可参考以下SDK demo:
    Github地址
    Java SDK demo
    Gitee地址(Github无法访问时选择)

    Java SDK demo

    API接入

    如果您选择非SDK接入,使用API方式接入,请参考各开发语言汇总示例代码

    该接口的使用方法具体示例如下:

    • Github地址

    PHP示例代码
    Python示例代码
    Golang示例代码
    C#示例代码

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

    PHP示例代码
    Python示例代码
    Golang示例代码
    C#示例代码

    Online Chat Tel:95163223 Free trial