> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Chat API リファレンス

テキストベースのチャット機能




テキストベースのチャット機能を提供します。

メッセージデータはルームごとに管理され、ネームスペース設定で設定した期間(1日〜30日)分のログが保持されます。<br>
ルームにはパスワードを設定でき、設定した場合はメッセージの取得や投稿リクエストにパスワードが必要となります。<br>
ルームにはユーザーIDのホワイトリストを設定でき、設定した場合はホワイトリストに含まれるゲームプレイヤーにしかメッセージの取得や投稿ができなくなります。

メッセージにはカテゴリを設定でき、クライアント側でペイロードのパース方法を切り替えることができます。<br>
たとえば、 `カテゴリ0` はテキストがペイロードにそのまま含まれる、`カテゴリ1` はペイロードにスタンプのIDが含まれる、といった使い方ができます。

ルームを購読すれば、ルームに対して新しい投稿があったときにサーバからプッシュ通知を受け取ることができます。<br>
このとき、通知を受けたいカテゴリを設定できますので、メッセージの種類や重要度別にカテゴリを分ければ、ゲームプレイヤーが通知を受け取るメッセージの種類を設定できるようになり、ユーザー体験を向上させることができます。<br>
また、購読の設定には `モバイルプッシュ通知に転送するか` という設定もありますので、うまく活用してください。

[マイクロサービス紹介 / GS2-Chat](../../microservices/chat)



- [GS2-Chat Deploy/CDK リファレンス](/ja/api_reference/chat/deploy/)
  
- [GS2-Chat SDK API リファレンス](/ja/api_reference/chat/sdk/)
  
- [GS2-Chat SDK for Game Engine API リファレンス](/ja/api_reference/chat/game_engine/)
  
- [GS2-Chat スクリプト トリガー リファレンス](/ja/api_reference/chat/script/)
  
- [GS2-Chat マスターデータリファレンス](/ja/api_reference/chat/master_data/)