查询角色列表

业务场景

  1. 获取用户在指定区服的全部角色信息，包括创角时的渠道信息
  2. 使用场景，包括但不限：线下充值、运营活动、论坛

注意事项

  1. 入参openid，都是小写字母
  2. 入参gameId，不是出包的 appId

接口地址

地址由CP提供

接口说明

  1. 协议：HTTPS
  2. 方式：POST
  3. ContentType：application/json;charset=utf-8
  4. 请求报文：
字段类型必需参与签名说明
gameIdlong是是游戏项目id(并非出包的 appId)
openidstring是是SDK用户唯一标识
serverIdstring是是游戏区服ID
timestamplong是是毫秒时间戳
signstring是否签名
  1. 响应报文：
字段类型必需说明
codeint是响应状态码
msgstring是响应描述
dataarray否结果数据

data结构体

字段类型必需说明
roleIdstring是角色ID
roleNamestring是角色名称
appIdlong是SDK的appId(从客户端的GetDataInfo获取)
channelIdstring否SDK的渠道id(从客户端的GetDataInfo获取)
taskNumint否任务值（判断是否可以登录活动页，null或0：不能登录，1：可以登录）
extraobject否扩展信息

extra结构体

字段类型必需说明
roleLevelint否角色等级
roleVipint否VIP等级
roleRevivalint否角色转生数,无转生系统时可传0
rolePowerlong否角色战力值
roleCreateTimelong否角色创建时间, unix时间戳(秒)

请求示例

{
        "gameId": 21573,
    	"openid": "12345678912345678912345",
    	"serverId": "40107",
        "timestamp": 1654142913840,
        "sign": "da8f309131f40268ea5c19d8d68af00d"
}

响应示例

{
	"code": 0,
	"msg": "成功",
	"data": [{
			"roleId": "2700033751",
			"roleName": "云卷",
			"appId": 20106,
			"channelId": "1029",
			"taskNum": 1,
			"extra": {
				"roleLevel": 22,
				"roleVip": 9,
				"roleRevival": 2,
				"rolePower": 98945,
				"roleCreateTime": 1520906206
			}
		},
		{
			"roleId": "2700046136",
			"roleName": "毛毛",
			"appId": 20106,
			"channelId": "1029",
			"taskNum": 0,
			"extra": {
				"roleLevel": 10,
				"roleVip": 3,
				"roleRevival": 1,
				"rolePower": 999,
				"roleCreateTime": 1520906331
			}
		}
	]
}

签名规则

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

调试示例

import cn.hutool.crypto.SecureUtil;

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

public class SignExample {

    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) {
        String appKey = "AaBbCcDdEeFfGgHh";
        Map<String, Object> reqMap = new HashMap<>();
        reqMap.put("gameId", 21573L);
        reqMap.put("openid", "12345678912345678912345");
        reqMap.put("serverId", "40107");
        reqMap.put("timestamp", 1654142913840L);
        System.out.println(String.format("查角色签名:%s", getMd5Sign(reqMap, appKey)));
    }
}