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

# GS2-Chat API Reference

Text chat feature




Provides text-based chat functionality.

Message data is managed per room, and logs for the period set in the Namespace settings (1 to 30 days) are retained.
Rooms can be assigned a password, and if so, passwords are required to retrieve messages and post requests.
Rooms can be assigned a user ID whitelist, which means that only game players on the whitelist will be able to retrieve and post messages.

Messages can be categorized, allowing the client to toggle how the payload is parsed.
For example, for `category 0` the text is included in the payload as is. `Category 1` includes the ID of the stamp in the payload. You can use `category 1` in this way.

If you subscribe to a room, you will receive push notifications from the server when new posts are made to the room.
At this time, you can set the categories in which you would like to receive notifications. By dividing the categories by message type and importance, you can improve the user experience by allowing game players to set the types of messages for which they would like to receive notifications.
There is also a setting in the subscription settings to `forward to mobile push notifications`, so make good use of it.

[Introduction to Microservices / GS2-Chat](../../microservices/chat)



- [GS2-Chat Deploy/CDK Reference](/api_reference/chat/deploy/)
  
- [GS2-Chat Master Data Reference](/api_reference/chat/master_data/)
  
- [GS2-Chat Script Trigger Reference](/api_reference/chat/script/)
  
- [GS2-Chat SDK API Reference](/api_reference/chat/sdk/)
  
- [GS2-Chat SDK for Game Engine API Reference](/api_reference/chat/game_engine/)