封禁/处置信息上报接口

2024.02.22 09:47:22

    接口说明

    本接口用于上报封禁/处置信息。

    鉴权说明

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

    接入须知

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

     

    请求说明

    请求地址

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

    请求头

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

    请求参数

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

    参数 类型 必填 描述
    handleObjectType Integer 需要进行处置的对象的类型,包括以下可选值:
    1:account(处置对象是用户/玩家账号)
    2:ip(处置对象是ip地址)
    3:deviceId(处置对象是设备)
    objectId String 封禁/处理信息内容,与handleObjectType字段搭配使用
    roleId String 如处置对象是属于某个账号下的某个角色,则请补充角色ID
    action Integer 封禁/处置的动作。通过以下枚举进行区分:
    1:踢下线
    2:封禁(一定时间内禁止登录使用app)
    3:封停(永久禁止登录使用app)
    4:功能限制(禁止使用某些功能,如:禁止评论)
    5:降级(降低账号等级,通常仅用于处置对象为:账号的情况)
    6:玩法限制(禁止参与某个app中的活动、玩法等)
    7:玩法干预(削减用户/玩家收益)
    8:其他
    actionDes String 自定义内容,封禁/处置动作的详情说明,如:action为封禁时,可填入封禁天数;action为功能限制时,可填入禁止使用的功能编号等。
    reason String 自定义内容,封禁/处置的原因,如:因引流被处置。

    请求参数示例

    {
        "businessId": "xxx966f73yyy59440583zzz9bfcc79df",
        "secretId": "nnn966f73yyy59440583zzz9bfcc79dc",
        "timestamp": ${currentTimeMs},
        "nonce": "mmm888f73yyy59440583zzz9bfcc79de",
        "version": "500",
        "signature": "lll888f73yyy59440583zzz9bfcc79da",
        "handleObjectType": 1,
        "objectId": "account01",
        "roleId": "roleId001",
        "action": 2,
        "actionDes": "xxx",
        "reason": "xxx"
    }
    
    

    响应

    响应结果

    响应数据格式为:JSON。

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

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

    响应结果示例

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

    响应返回码

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

    接入示例代码

    开发工具集(SDK)接入

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

    • 准备工作

    准备步骤详见通用步骤

    • 使用方法

    该接口的使用方法可参考以下SDK demo:

    JAVA SDK demo

    GOLANG SDK demo

    Online Chat Tel:95163223 Free trial