角色列表(板块)

请求 URL:

  • /getRoleListByPlate

请求方式: POST

认证: 需要登录,请在请求头携带有效的 Authorization

1. 请求参数

参数名 必选 类型 说明
appId string App ID
udid string 设备 UDID
plateId uint 板块 ID;不传或传 0 时获取跨板块角色
page int 页码,默认 1,小于等于 0 时按 1 处理
pageSize int 每页数量,默认 10,小于等于 0 时按 10 处理

2. 指定板块时的返回

plateId > 0 时,data 包含板块详情及角色列表。

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "plateId": 2,
    "titleDetail": "热门角色",
    "imageDetail": "https://example.com/plate-detail.png",
    "descDetail": "本板块收录近期热门角色。",
    "star": 128,
    "list": [
      {
        "id": 543,
        "name": "Marcus Johnson",
        "avatar": "https://example.com/avatar.png",
        "background": "https://example.com/background.png",
        "plateId": 2,
        "isFavorite": false
      }
    ]
  }
}
参数名 类型 说明
code int 状态码,200 表示成功
msg string 提示信息
data object 板块详情及角色列表
data.plateId uint 板块 ID
data.titleDetail string 板块详情页标题
data.imageDetail string 板块详情页图片
data.descDetail string 板块详情页描述
data.star uint 板块点赞数
data.list array 角色列表,角色字段与 /getRoleList 返回的角色对象一致

3. 未指定板块时的返回

plateId 不传或为 0 时,data 直接返回角色数组,不包含板块详情外层对象。

  • page = 1:依次从每个当前用户可见的板块取最多 pageSize 个角色并合并返回。各板块候选角色 ID 缓存 24 小时。
  • page > 1:对全部符合条件的角色进行普通分页,不再按板块分别取数。
{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 543,
      "name": "Marcus Johnson",
      "avatar": "https://example.com/avatar.png",
      "background": "https://example.com/background.png",
      "plateId": 2,
      "isFavorite": false
    }
  ]
}

角色对象的完整字段说明请参考 /getRoleList 接口文档。

4. 常见状态码

状态码 说明
200 成功
510 系统错误
670 登录失效
800 参数错误
900 指定的板块不存在或已删除
2021 © Live all right reserved,powered by Gitbook该文件修订时间: 2026-08-06 10:09:17

results matching ""

    No results matching ""