注释
这解释了在使用匹配 API 时需要参考的信息。
错误代码
如果匹配 API 请求未正确处理,它会提供一个单独的错误代码,除了 HTTP 响应状态代码,以帮助识别原因。
错误代码可以作为每个匹配 API 请求的响应值进行检查,并以以下 JSON 数据格式构造。
// 예시)
{
"code": 11001,
"reason": "already group member"
}
Note
在错误代码响应中,每个 code 的值是固定的,但 reason(错误原因)可能会根据 API 更新而修改。
根据API响应错误提供的错误代码类型如下。
一般错误代码
| 代码 | 描述 |
| 1000 | 内部服务器系统错误 |
| 1001 | 请求数据中 body 的值存在有效性问题 |
| 1002 | API 服务器错误 |
| 1100 | 在使用 HTTP 方法 - GET 的 API 中,如果缺少必需的参数值 |
API 认证错误代码
| 代码 | 描述 |
| 2000 | Hive 认证密钥丢失 |
| 2001 | Hive 认证密钥的值不正确 |
| 2002 | gameIndex的值不正确 |
| 2100 | 此 API 不可用 |
| 2200 | 没有可用于身份验证验证的数据 |
| 2201 | 如果用于身份验证验证的数据格式不受支持 |
| 2300 | 用于 Hive SDK 身份验证的数据不正确 |
| 2310 | 不是注册的 appId |
| 2320 | 无法进行实际的 Hive SDK 认证请求 |
API 通用错误代码
| 代码 | 描述 |
| 3000 | 未能获取关于 API 用户的信息 |
| 3001 | 无法从 API 路径中检索到 gameIndex 值 |
| 3002 | 无法从 API 路径中检索到 matchId 信息 |
| 3003 | 无法读取请求体的内容(解析问题) |
| 3004 | 无法从请求中获取 playerId 信息 |
| 3005 | 无法从请求中获取 targetPlayerId 信息 |
与匹配 ID (matchId) 相关的错误代码
| 代码 | 描述 |
| 4000 | 无法检索 matchId 信息 |
| 4001 | 无法从 API 路径获取 gameIndex 值 |
| 4100 | 创建或修改 matchId 所需的信息不正确 |
个人 API 相关错误代码
| 代码 | 描述 |
| 10000 | 匹配请求已经在进行中(重复请求) |
| 10100 | 删除匹配请求时,没有请求可以删除 |
组 API 相关错误代码
| 代码 | 描述 |
| 11000 | 不在该组内 |
| 11001 | 已经在一个组内 |
| 11002 | 不是该组的成员 |
| 11003 | 不是组长 |
| 11004 | 找不到与输入代码对应的组 |
| 11005 | 在属于一个组时无法使用 |
| 11006 | 在(组)匹配期间无法使用 |
| 11100 | 在(个人)匹配进行时无法创建 |
| 11101 | 如果不是团队匹配则无法创建 |
| 11200 | 组匹配进行中(重复) |
| 11201 | 有未准备好的成员 |
| 11202 | 没有其他成员(单独请求不可能) |
| 11300 | 由于正在进行匹配无法更改 |
| 11301 | 组长无法更改 |
| 11400 | 由于成员已满无法参与 |
| 11401 | 由于匹配规则(分数等)限制无法参与 |
| 11402 | matchId无法参与另一个组 |
| 11500 | 准备好的成员无法离开 |
| 11600 | 没有匹配请求可以删除 |
| 11700 | 组长无法强制驱逐 |