Chat
Last updated on
Overview
AccelByte Cloud's Chat service allows players to send and receive messages to their friends or party members in real-time. This service includes notifications to inform users of messages being sent or received. The Chat service is divided into three basic features:
- Chat: Send Personal Chat allows players to message their friends. The sender will receive a notification when their message has been sent, and the recipient will receive a notification when they have a new message.
- Chat: Send Party Chat allows users to send a message to all of the players in their party. The party members will be notified when they have a new message from the sender.
- Load Personal Chat History involves retrieving a player's chat history with another player. This action can be performed by sending an HTTP Request only if the player has permission to perform this action, i.e. the player hasn't been blocked.
- Global Chat allows users to broadcast messages to all users within the game. By default, the user can join a global channel and start broadcasting messages to other users in the game.
Permissions
Permissions are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to manage chat in the Admin Portal.
| Usage | Resource | Action |
|---|---|---|
| Load Personal Chat History | NAMESPACE:{namespace}:USER:{userId}:CHAT | Read |
| Get Chat History | NAMESPACE:{namespace}:USER:{userId}:CHAT | Read |
| Load Personal Chat History based on Friend's User ID | Required valid user authorization | Read |
Permissions work slightly differently depending on whether they are assigned to IAM Clients or Roles assigned to users. For more information, read the Authentication and Authorization documentation.