> 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 레퍼런스](/ko/api_reference/chat/deploy/)
  
- [GS2-Chat SDK API 레퍼런스](/ko/api_reference/chat/sdk/)
  
- [GS2-Chat SDK for Game Engine API 레퍼런스](/ko/api_reference/chat/game_engine/)
  
- [GS2-Chat 마스터 데이터 레퍼런스](/ko/api_reference/chat/master_data/)
  
- [GS2-Chat 스크립트 트리거 레퍼런스](/ko/api_reference/chat/script/)