基本信息
本節說明了在使用 Chat 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 位元組） |