GS2-Inbox API Reference

This service provides a message function with a gift.

Messages have a read status. You can configure whether to keep read messages in the list or remove them from the list.

Rewards can be attached to messages. Instead of just marking a message as read, the player can receive the reward attached to the message.

Messages can have an expiration date (expiresAt). Messages that reach their expiration date are automatically deleted, regardless of whether they are unread or have been read.

When you want to distribute the same message to all players rather than to a specific player, use a “global message”. A global message is defined as master data, and when each player calls ReceiveGlobalMessage, any messages they have not yet received are copied into their inbox.

Master data can be registered from the Management Console, or you can set up a workflow that reflects data from GitHub or registers via CI using GS2-Deploy.