内容校验

业务场景

机器审核玩家的发言、名字、头像图片等,并将审核结果返回给CP,与[内容审核通知]接口配套使用。

注意事项

时间戳与北京时间差距为 ± 5分钟

流程图

接口地址

https://cpapi.iyagame.com/v1/content/monitor

接口说明

  1. 协议:HTTPS
  2. 方式:POST
  3. ContentType:application/json;charset=utf-8
  4. 请求报文:
字段类型必需参与签名说明
appIdlongSDK的appId
openIdstringSDK用户唯一标识
serverIdstring游戏区服ID
roleIdstring游戏角色ID
typeint校验类型:1-文本校验 2-图片校验(url格式) 3-图片校验(base64格式)
contentstring校验内容,需填写与type对应的值,type为1时长度为1024字符
timestamplong毫秒时间戳
signstring签名
  1. 响应报文:
字段类型必需说明
codeint响应状态码
msgstring响应描述
dataobject结果数据

data字段

字段类型必需说明
resultint检查结果: 0-通过, 1-建议审核, 2-不通过
contentstring文本校验时返回,返回的文本会将屏蔽词屏蔽,其他内容正常
taskIdstring当次请求的唯一标识

请求示例

{
    "appId": 10070,
    "openId": "12345678912345678912345",
    "serverId": "serverId",
    "roleId": "roleId",
    "type": 1,
    "content": "fuck you, i am a good man",
    "timestamp": 1742214770340,
    "sign": "ed003340899fbf6b3e0ecd998e1df48b"
}

响应示例

{
    "code": 0,
    "msg": "Success",
    "data": {
        "result": 2,
        "content": "**** ***, i am a good man",
        "taskId": "43052b74"
    },
    "meta": {
        "tid": "43052b74"
    }
}

签名规则

  1. 参数名区分大小写,按 ASCII 码从小到大排序(字典序)
  2. 只有值为 null 和 参数名不参与签名 的键值对,才不参与签名
  3. 使用 URL 键值对的格式,拼接成待签名字符串,签名 key 在最后拼接,再进行MD5计算
  4. 将生成的签名与入参 sign 值作校验,验签忽略大小写

调试示例

import cn.hutool.crypto.SecureUtil;
import com.alibaba.nacos.shaded.com.google.common.collect.Maps;

import java.util.Map;
import java.util.TreeMap;

public class Example {

    public static String getMd5Sign(Map<String, Object> params, String appKey) {
        TreeMap<String, Object> sortedParams = new TreeMap(params);
        StringBuilder builder = new StringBuilder(512);
        sortedParams.forEach((k, v) -> {
            if (v != null) {
                builder.append(k).append("=").append(v).append("&");
            }
        });
        builder.append("key=").append(appKey);
        return SecureUtil.md5(builder.toString());
    }

    public static void main(String[] args) {
        Map<String, Object> params = Maps.newLinkedHashMap();
        params.put("appId", 10070);
        params.put("openId", "12345678912345678912345");
        params.put("serverId", "serverId");
        params.put("roleId", "roleId");
        params.put("type", 1);
        params.put("content", "fuck you, i am a good man");
        params.put("timestamp", 1742214770340L);
        String appKey = "AaBbCcDdEeFfGgHh";
        System.out.println(String.format("签名:%s", getMd5Sign(params, appKey)));
    }
}

状态码

状态码说明
0成功
-1失败,常规性错误
10101查询基础信息失败
10102缺少游戏信息
10103请求参数全部为空
10104缺少签名sign
10105签名不正确
10106timestamp已过期
10401请求超时,可重试
10402请求异常,可重试
10403content长度超过限制