You need to enable JavaScript to run this app.
导航

公共参数

最近更新时间2022.12.29 10:57:54

首次发布时间2022.12.29 10:57:54

1. 公共请求参数

字段名称字段类型字段说明
AppIdint应用ID,同一个商户可能有多个产品,为了区分每个产品而生成一个产品唯一标识。在火山引擎控制台,如果已有想要接入风险识别的应用,直接将该应用的ID的值赋给AppId字段,如果没有则可创建新应用
Servicestring要请求的服务类型,如:login表示登录检测,register表示注册检测
ParametersstringJSON格式,表示要传的参数上下文

2. 公共返回参数

参数列表

字段名称字段类型字段说明
RequestIdstring本次请求的唯一标识
Codeint请求返回码,为0表示成功,不为0表示异常
Messagestring请求返回描述,和请求返回码对应
DataData返回风险结果数据
Data
Decisionstring当前决策结果,包括BLOCK和PASS
Detailstring风险详情信息,往往包含相应的决策所需操作,当决策为BLOCK的时候需要关注

这里提供的是决策【建议】,需要甲方在游戏中实施

返回样例

用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId给用户。

{
    "Result": {
        "RequestId": "2021011016095301020405020334544FB2",
        "Code": 0,  // 0表示请求成功
        "Message": "success",
        "Data": {
            "Decision": "BLOCK", // BLOCK or PASS
            "Detail": "review" // 预留的风险详情字段
        }
    }
}

3. 返回参数说明

返回code的说明:

code对应的message含义描述
0success请求正常。
1001invalid parameters
参数不合法。
1002auth failed
认证失败。
1003no permission
权限不足,服务未开通或已到期。
1004qps limit
QPS超过已购规格,限流。
1005insufficient balance余额/余量不足
2000internal error
内部服务器错误。