基本信息
本节解释了在使用聊天 API 之前您需要了解的基本信息。
先决条件
要使用聊天 API，您需要以下项目：
- Hive 认证密钥：用于 API 调用的身份验证令牌
- 可以在 Hive 控制台 > 应用中心 > 项目管理 > 游戏详情 > 基本信息 中找到
- 游戏索引：在 Hive 控制台 > 应用中心 > 项目管理 中创建的游戏索引
Warning
- Hive 认证密钥是敏感的安全信息，绝不能外部暴露。出于安全考虑，避免直接将其包含在源代码中。如果您需要在客户端环境中实现功能，请使用 Hive SDK。
- 所有聊天 API 以 服务器到服务器的通信 方式运行。如果您直接从游戏客户端调用 API，可能会存在身份验证令牌泄露和意外问题的风险，因此请谨慎使用。
常见头部
| 字段名称 | 描述 | 类型 | 必需 |
| Authorization | API 调用的认证令牌 (Bearer) | 字符串 | 是 |
| Content-Type | 请求数据的类型 (application/json) | 字符串 | 是 |
响应代码
| HTTP 状态码 | 代码 | 消息 | 描述 |
| 200 | 0 | 成功。 | 成功 |
| 400 | 100 | 错误请求。 | 无效请求 |
| 401 | 101 | 无效的令牌。 | 无效令牌 |
| 403 | 102 | 禁止访问。 | 无权限 |
| 404 | 103 | 未找到。 | 未找到 |
| 405 | 104 | 不允许的方法。 | 不允许的方法 |
| 500 | 105 | 服务器内部错误。 | 服务器内部错误 |
| 503 | 108 | 服务器繁忙，请稍后再请求。 | 服务器超载 |
| HTTP 状态码 | 代码 | 消息 | 描述 |
| 400 | 200 | 重复的频道 ID。 | 重复的频道 ID |
| 400 | 201 | 找不到频道或频道已被删除。 | 找不到频道或频道已被删除 |
| 400 | 202 | 频道已满。 | 由于超出参与者限制，无法进入频道 |
| 400 | 203 | 无效的频道密码。 | 无效的频道密码 |
| 400 | 204 | 消息大小超出限制。最大大小为 200。 | 消息大小超出限制（最大 200 个字符） |
| 400 | 300 | 用户不在会话中。 | 用户不在会话中（未连接到套接字服务器） |
| 400 | 301 | 用户不在频道中。 | 用户不在频道中 |
| 400 | 302 | 用户已经在频道中。 | 用户已经在频道中 |
| 400 | 303 | 用户已被阻止。 | 用户已被阻止 |
| 400 | 304 | 阻止列表已满。最大大小为 100。 | 阻止列表已满（最多 100 个用户） |
| 400 | 305 | 用户不在阻止列表中。 | 用户不在阻止列表中 |
| 400 | 306 | 用户已被阻止。 | 用户已被阻止 |
| 400 | 307 | 用户可以进入的频道数量已超过最大限制。 | 超过用户可以进入的频道数量 |
| 403 | 308 | 用户不是频道的拥有者。 | 用户不是频道的拥有者 |
| 400 | 400 | 自定义消息大小超出限制。最大大小为 8,000 字节。 | 自定义消息大小超出限制（最大 8,000 字节） |