基本情報
このセクションでは、Chat APIを使用する前に知っておくべき基本情報について説明します。
前提条件
Chat APIを使用するには、以下のアイテムが必要です：
- Hive 認証キー: API呼び出し用の認証トークン
- **Hive コンソール > アプリセンター > プロジェクト管理 > ゲーム詳細 > 基本情報**にあります
- ゲームインデックス: **Hive コンソール > アプリセンター > プロジェクト管理**で作成されたゲームのインデックス
Warning
- Hive 認証キーは機密性の高いセキュリティ情報であり、外部に公開してはいけません。セキュリティのため、ソースコードに直接含めることは避けてください。クライアント環境で機能を実装する必要がある場合は、Hive SDK を使用してください。
- すべてのチャット API は サーバー間通信 の方式で動作します。ゲームクライアントから直接 API を呼び出すと、認証トークンの漏洩や予期しない問題が発生するリスクがあるため、注意して使用してください。
一般的なヘッダー
| フィールド名 | 説明 | タイプ | 必須 |
| Authorization | API呼び出しの認証トークン（Bearer） | 文字列 | Y |
| Content-Type | リクエストデータのタイプ（application/json） | 文字列 | Y |
レスポンスコード
| 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バイト） |