Game client notifications

Last updated on October 23, 2024

Overview

AccelByte Gaming Services (AGS) Play's game client notification system quickly delivers relevant game information to the players through the game client. It uses the WebSocket messaging protocol from AGS Lobby to send multiplayer notifications from the backend to the game client.

This article contains a list of game client notifications the system provides.

Basic structure

Multiplayer notifications can consist of several parts:

• type - String: messageNotif, messageSessionNotif, connectNotif.
• id - String UUIDv4: Generated identifier of the WebSocket message.
• to - String UUIDv4: AccelByte user ID of the user who receives message.
• topic - String: The message topic can vary depending on the context.
• payload - String base64: The base64 encoded message in JSON format.
• sendAt - String timestamp: The time when the notification will send to the user.
• sequenceID - Int64 unix timestamp: Sequence ID is an identifier for a connection to the Lobby WebSocket (WS). A new WS connection will generate a different sequence ID. Only some notifications related to the matchmaking and session flow will have the sequence ID number.
• sequenceNumber - Int: Sequence number is an incremental number for identifiying the matchmaking flow end-to-end sequentially. It also can be used to identify if there is a missing notification during the matchmaking process. Only some notifications related to the matchmaking and session flow will have the sequenceNumber field.

Matchmaking notification

The following sections outline notifications related to matchmaking.

OnMatchFound

AGS Matchmaking will send the OnMatchmakingStarted notification to a user when their matchmaking request successfully finds a new match or backfills to an active session.

type: messageNotif
id: e96f80aa893949489a6f8f3f58b65830
from: system
to: 728e6d7725d34904a726beadfe434e30
topic: OnMatchFound
payload:ewogICJJRCI6ICJiZWYyMzllNDg1MDI0NzljOGEwZTcwMzgwMzkzOGVmYSIsCiAgIk5hbWVzcGFjZSI6ICJ0ZXN0IiwKICAiQ3JlYXRlZEF0IjogIjIwMjQtMTAtMDdUMDk6Mjk6MzJaIiwKICAiTWF0Y2hQb29sIjogInRlc3RtYXRjaHBvb2wiLAogICJUZWFtcyI6IFsKICAgIHsKICAgICAgIlVzZXJJRHMiOiBbCiAgICAgICAgImM5ZmI1ZmQ1ZWM1NDQ3ZDhhYjgwYWNkNDNkN2E3MGQzIgogICAgICBdCiAgICB9LAogICAgewogICAgICAiVXNlcklEcyI6IFsKICAgICAgICAiOGZkNDk1M2E2MWNhNDEzOTgwMDQ5OWI3NjlkZGNkMjYiCiAgICAgIF0KICAgIH0KICBdLAogICJUaWNrZXRzIjogWwogICAgewogICAgICAiVGlja2V0SUQiOiAiYjY0YzUwYzNkMzc5NGI2YmI4OTdiYTNhYjFhZjE5YzMiCiAgICB9LAogICAgewogICAgICAiVGlja2V0SUQiOiAiYjMxY2ZkNzIyOGFkNGU1ZGEyOTA5N2Y2NmQzNmU5YjUiCiAgICB9CiAgXQp9
sentAt: 2024-10-07T09:29:34Z

OnMatchmakingStarted

AGS Matchmaking will send the OnMatchmakingStarted notification to a party member when they create a match ticket with the session ID (partyID/gameSessionID).

type: messageNotif
id: b0824cb9211d442eb85ab8862682c8c1
from: system
to: f83ce41c17094253a29f718c3d6ba4d4
topic: OnMatchmakingStarted
payload: eyJUaWNrZXRJRCI6Ijc3YzM4NjkzZDhiZDQyM2NhNThlZDc4NjRhNTgyZDhhIiwiUGFydHlJRCI6IjU5NzQ2NjE1MjhhNDRiZTVhMDFkYjliY2Q4YmNiNjI4IiwiTmFtZXNwYWNlIjoiYWNjZWxieXRlIiwiQ3JlYXRlZEF0IjoiMjAyNC0xMC0wN1QxMzo1ODowM1oiLCJNYXRjaFBvb2wiOiJ0ZXN0TWF0Y2hwb29sIiwiVGlja2V0SW5mb3JtYXRpb24iOnsiQ3Jvc3NQbGF0Zm9ybXMiOm51bGwsIkNyb3NzUGxheUVuYWJsZWQiOmZhbHNlfX0=
sentAt: 2024-10-07T13:58:04Z
sequenceID: 1728309473
sequenceNumber: 3

OnMatchmakingTicketExpired

AGS Matchmaking will send the OnMatchmakingTicketExpired notification to the user indicating that their matchamking ticket has expired because matchmaking could not find enough matching players before the match ticket expiration time elapsed (configurable in the matchpool).

type: messageNotif
id: 33b6217ead5f490394bc31a73556c223
from: system
to: 1a363414a3ba475ba715d805a993039e
topic: OnMatchmakingTicketExpired
payload: eyJUaWNrZXRJRCI6Ijc3YzM4NjkzZDhiZDQyM2NhNThlZDc4NjRhNTgyZDhhIiwiTmFtZXNwYWNlIjoiYWNjZWxieXRlIiwiQ3JlYXRlZEF0IjoiMjAyNC0xMC0wN1QxMzo1Nzo0OVoiLCJNYXRjaFBvb2wiOiJ0ZXN0TWF0Y2hwb29sIiwiUmVhc29uIjoiZXhwaXJlZCB0aWNrZXQifQ
sentAt: 2024-10-07T13:57:50Z
sequenceID: 1728309443
sequenceNumber: 3

OnMatchmakingTicketCanceled

AGS Matchmaking will send the OnMatchmakingTicketCanceled notification to the player or all party members when the matchmaking request has been canceled (deleted).

type: messageNotif
id: e6706b96ecbe440fb117009ceafba3a3
from: system
to: 4ca9abffeb7d4c8f8a5d173599370618
topic: OnMatchmakingTicketCanceled
payload: eyJOYW1lc3BhY2UiOiJhY2NlbGJ5dGUiLCJVc2VySURzIjpbImY1NTEyYzc5ZDEzODRlM2E5MGI3OTc1ZDU1NGYzZmViIl0sIlJlYXNvbiI6InVzZXIgZGVsZXRlIHRpY2tldCIsIlRpY2tldElEIjoiZGJiNjhiY2ZhZjQ5NDBiNDhjZGU4NDNmMWJmYTJkM2QifQ
sentAt: 2024-10-07T13:58:08Z

Game session

The following sections outline notifications related to game sessions.

OnSessionInvited

AGS Session will send the OnSessionInvited notification to the player when they have been invited to a game session via a direct invite, matchmaking, or a game session put/patch (only for the new additional members).

type: messageSessionNotif
topic: OnSessionInvited
payload: eyJTZXNzaW9uSUQiOiIyZTlmNjFmMTgzNGY0MDU2YTE0NzBkMjQxNzY1OGNkMyIsIlNlbmRlcklEIjoiNTUyY2Y2ZDU3YjRlNGUwMWI4MGEwNDQ1NjUyZjRjMTQiLCJFeHBpcmVkQXQiOiIyMDI0LTEwLTA4VDA1OjE2OjMwLjUwODQ3MjgyNloifQ
sentAt: 2024-10-08T05:11:30Z
sequenceID: 1728364284
sequenceNumber: 2 

OnSessionRejected

AGS Session will send the OnSessionRejected notification to the active session members when a game session invitation has been rejected by the invited player.

type: messageSessionNotif
topic: OnSessionRejected
payload: eyJNZW1iZXJzIjpbeyJJRCI6ImIyMDMzZGVlOThiZjQwNmViZTYwZDI4YzU2MmU2NDgzIiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDA1OjExOjMwLjkwOFoifSx7IklEIjoiODJhNjVlZWVlNThiNDc4OGI3ZTJkZTliMjI5ZTBkMTMiLCJTdGF0dXMiOiJSRUpFQ1RFRCIsIlN0YXR1c1YyIjoiUkVKRUNURUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDA1OjExOjMxLjMyNloifSx7IklEIjoiNDU5NjJmMmFkY2EzNDZjZThlYzg4NGFmZWUwYjgxMmYiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMDU6MTE6MzAuNDk3WiJ9XSwiU2Vzc2lvbklEIjoiNzdjMzg2OTNkOGJkNDIzY2E1OGVkNzg2NGE1ODJkOGEiLCJSZWplY3RlZElEIjoiNTk3NDY2MTUyOGE0NGJlNWEwMWRiOWJjZDhiY2I2MjgifQ
sentAt: 2024-10-08T05:11:31Z 

OnSessionKicked

AGS Session will send the OnSessionKicked notification to the member who is being kicked from the game session because of a game put/patch operation, a leader kicking the player, or a kick operation by the system.

type: messageSessionNotif
topic: OnSessionKicked
payload: eyJTZXNzaW9uSUQiOiIzM2I2MjE3ZWFkNWY0OTAzOTRiYzMxYTczNTU2YzIyMyIsIlRleHRDaGF0IjpmYWxzZX0
sentAt: 2024-10-08T05:11:32Z

OnSessionJoined

AGS Session will send the OnSessionJoined notification to the user who joins a game session from an invitation. The other active game session members will receive the OnSessionMembersChanged for this event.

type: messageSessionNotif
topic: OnSessionJoined
payload: eyJTZXNzaW9uSUQiOiIxYTM2MzQxNGEzYmE0NzViYTcxNWQ4MDVhOTkzMDM5ZSIsIk1lbWJlcnMiOlt7IklEIjoiYjA4MjRjYjkyMTFkNDQyZWI4NWFiODg2MjY4MmM4YzEiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMDU6MTE6MzAuOTA4WiJ9LHsiSUQiOiJmOTQ2OWZkYWEwZDU0MjdhYjRlMmI0ZDM3MDY5MTM4NCIsIlN0YXR1cyI6IklOVklURUQiLCJTdGF0dXNWMiI6IklOVklURUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDA1OjExOjMwLjQ5N1oifSx7IklEIjoiZjgzY2U0MWMxNzA5NDI1M2EyOWY3MThjM2Q2YmE0ZDQiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMDU6MTE6MzAuNDk3WiJ9XSwiVGV4dENoYXQiOmZhbHNlfQ
sentAt: 2024-10-08T05:11:31Z
sequenceID: 1728364284
sequenceNumber: 3 

OnSessionMembersChanged

AGS Session will send the OnSessionMembersChanged notification to the active game session members when there is a change in the member status (e.g., JOINED, DISCONNECTED, LEFT, etc.). The AGS Game SDK will listen for this message and parse the version information data to be stored in the local cache.

type: messageSessionNotif
topic: OnSessionMembersChanged
payload: eyJKb2luZXJJRCI6IjdhYjc2MjcwZTI0ODRjMWM4MmVjNTYzMDk4ZTNjYmEzIiwiTGVhZGVySUQiOiJkYTczZGJkYWQ0ZGM0MTUzOTYxZTNiNDdkZWUwODM4MyIsIlNlc3Npb25JRCI6ImYwODYwYjExNzJlMzQ0MzM5Zjc1MDBjODNhYTg1ZDE1IiwiVGVhbXMiOlt7InVzZXJJRHMiOlsiN2FiNzYyNzBlMjQ4NGMxYzgyZWM1NjMwOThlM2NiYTMiLCIyOTBhMzE3OWRiNjU0NGUwODgyYjllZmZkNTdhYTk0NyJdLCJwYXJ0aWVzIjpbeyJwYXJ0eUlEIjoiIiwidXNlcklEcyI6WyI3YWI3NjI3MGUyNDg0YzFjODJlYzU2MzA5OGUzY2JhMyIsIjI5MGEzMTc5ZGI2NTQ0ZTA4ODJiOWVmZmQ1N2FhOTQ3Il19XX0seyJ1c2VySURzIjpbImRhNzNkYmRhZDRkYzQxNTM5NjFlM2I0N2RlZTA4MzgzIl0sInBhcnRpZXMiOlt7InBhcnR5SUQiOiIiLCJ1c2VySURzIjpbImRhNzNkYmRhZDRkYzQxNTM5NjFlM2I0N2RlZTA4MzgzIl19XX1dLCJUZXh0Q2hhdCI6ZmFsc2UsIkltcGFjdGVkVXNlcklEcyI6e30sIlNlc3Npb24iOnsiSUQiOiJmMDg2MGIxMTcyZTM0NDMzOWY3NTAwYzgzYWE4NWQxNSIsIk5hbWVzcGFjZSI6InNhbml0eXRlc3QiLCJNZW1iZXJzIjpbeyJJRCI6IjdhYjc2MjcwZTI0ODRjMWM4MmVjNTYzMDk4ZTNjYmEzIiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDA1OjExOjMwLjkwOFoifSx7IklEIjoiMjkwYTMxNzlkYjY1NDRlMDg4MmI5ZWZmZDU3YWE5NDciLCJTdGF0dXMiOiJJTlZJVEVEIiwiU3RhdHVzVjIiOiJJTlZJVEVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQwNToxMTozMC40OTdaIn0seyJJRCI6ImRhNzNkYmRhZDRkYzQxNTM5NjFlM2I0N2RlZTA4MzgzIiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDA1OjExOjMwLjQ5N1oifV0sIkF0dHJpYnV0ZXMiOnsicHJlZmVyZW5jZSI6eyJjcm9zc3BsYXlfZW5hYmxlZCI6ZmFsc2UsImN1cnJlbnRfcGxhdGZvcm0iOiJhY2NlbGJ5dGUiLCJzaW11bHRhbmVvdXNfcGxhdGZvcm0iOiIifX0sIkNyZWF0ZWRBdCI6IjIwMjQtMTAtMDhUMDU6MTE6MzAuNDk3WiIsIkNyZWF0ZWRCeSI6ImRhNzNkYmRhZDRkYzQxNTM5NjFlM2I0N2RlZTA4MzgzIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQwNToxMTozMC45MDhaIiwiVmVyc2lvbiI6MiwiQ29uZmlndXJhdGlvbiI6eyJOYW1lIjoidGVzdEdhbWVTYW5pdHktSU5WSVRFLTAxSjlOOEtWUlQ3SjQzOFdNUjNZS0dNVjYyIiwiSm9pbmFiaWxpdHkiOiJJTlZJVEVfT05MWSIsIk1pblBsYXllcnMiOjEsIk1heFBsYXllcnMiOjEwLCJUeXBlIjoiTk9ORSIsIkludml0ZVRpbWVvdXQiOjEwLCJJbmFjdGl2ZVRpbWVvdXQiOjUsImVuYWJsZVNlY3JldCI6ZmFsc2V9LCJDb25maWd1cmF0aW9uTmFtZSI6InRlc3RHYW1lU2FuaXR5LUlOVklURS0wMUo5TjhLVlJUN0o0MzhXTVIzWUtHTVY2MiIsIklzRnVsbCI6ZmFsc2UsIkxlYWRlcklEIjoiZGE3M2RiZGFkNGRjNDE1Mzk2MWUzYjQ3ZGVlMDgzODMiLCJUZWFtcyI6W3sidXNlcklEcyI6WyI3YWI3NjI3MGUyNDg0YzFjODJlYzU2MzA5OGUzY2JhMyIsIjI5MGEzMTc5ZGI2NTQ0ZTA4ODJiOWVmZmQ1N2FhOTQ3Il0sInBhcnRpZXMiOlt7InBhcnR5SUQiOiIiLCJ1c2VySURzIjpbIjdhYjc2MjcwZTI0ODRjMWM4MmVjNTYzMDk4ZTNjYmEzIiwiMjkwYTMxNzlkYjY1NDRlMDg4MmI5ZWZmZDU3YWE5NDciXX1dfSx7InVzZXJJRHMiOlsiZGE3M2RiZGFkNGRjNDE1Mzk2MWUzYjQ3ZGVlMDgzODMiXSwicGFydGllcyI6W3sicGFydHlJRCI6IiIsInVzZXJJRHMiOlsiZGE3M2RiZGFkNGRjNDE1Mzk2MWUzYjQ3ZGVlMDgzODMiXX1dfV0sIkRTSW5mb3JtYXRpb24iOnsiU2VydmVyIjpudWxsLCJTdGF0dXMiOiJORUVEX1RPX1JFUVVFU1QiLCJTdGF0dXNWMiI6Ik5FRURfVE9fUkVRVUVTVCJ9LCJDb2RlIjoiWEVCN1oyIn0sIlJlZHVjZVBheWxvYWRDb2RlIjpbMTAwMV19
sentAt: 2024-10-08T05:11:31Z
sequenceID: 1728364282
sequenceNumber: 2 

OnGameSessionInviteTimeout

AGS Session will send the OnGameSessionInviteTimeout notification to the user who is being invited to a game session, but failed to join within the invitation timeout period.

type: messageSessionNotif
topic: OnGameSessionInviteTimeout
payload: eyJTZXNzaW9uSUQiOiJmMDg2MGIxMTcyZTM0NDMzOWY3NTAwYzgzYWE4NWQxNSJ9
sentAt: 2024-10-08T05:11:43Z

OnGameSessionInviteCancelled

AGS Session will send the OnGameSessionInviteCancelled notification to the invited user when the inviter cancels the game session invitation.

type: messageSessionNotif
topic: OnGameSessionInviteCancelled
payload: eyJTZXNzaW9uSUQiOiJmMDg2MGIxMTcyZTM0NDMzOWY3NTAwYzgzYWE4NWQxNSJ9
sentAt: 2024-10-08T05:11:43Z

OnGameSessionUpdated

AGS Session will send the OnGameSessionUpdated notification to all active members when there is a a change in the game session data, including the session attribute, configuration, and leader status.

type: messageSessionNotif
topic: OnGameSessionUpdated
payload: eyJJRCI6ImM3MmUzODU3MGI3NzRjZDlhYjU0MmFiMTc0ZDk0ODQyIiwiTmFtZXNwYWNlIjoic2FuaXR5dGVzdCIsIk1lbWJlcnMiOlt7IklEIjoiZjNmMGQyMDIyNTcxNDRlZThjNjZlNzVjMzJmNDc0MWQiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMDY6MTk6MDYuOTg2WiJ9LHsiSUQiOiI4YzhlNzdmOGRhNzc0YTI4YTMyMDQ5NzQ0MGIwYjg2ZCIsIlN0YXR1cyI6IkpPSU5FRCIsIlN0YXR1c1YyIjoiSk9JTkVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQwNjoxOTowNi45ODZaIn0seyJJRCI6IjU5MWVlNmY2MzM1NjQ4YTM5MjA2ZTQzZmI3NTQ0YTYzIiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDA2OjE5OjA2Ljk4NloifV0sIkF0dHJpYnV0ZXMiOnsicHJlZmVyZW5jZSI6eyJjcm9zc3BsYXlFbmFibGVkIjpmYWxzZSwiY3VycmVudFBsYXRmb3JtIjoiYWNjZWxieXRlIiwic2ltdWx0YW5lb3VzUGxhdGZvcm0iOiIifX0sIkNyZWF0ZWRBdCI6IjIwMjQtMTAtMDhUMDY6MTk6MDYuOTg2WiIsIkNyZWF0ZWRCeSI6IjU5MWVlNmY2MzM1NjQ4YTM5MjA2ZTQzZmI3NTQ0YTYzIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQwNjoxOTowNi45ODZaIiwiVmVyc2lvbiI6MSwiQ29uZmlndXJhdGlvbiI6eyJOYW1lIjoidGVzdEdhbWVTYW5pdHktYXV0b2pvaW4tMDFKOU5DRktHV1dUWEcwMDQ4RkNZTkFKUzMiLCJKb2luYWJpbGl0eSI6Ik9QRU4iLCJNaW5QbGF5ZXJzIjoxLCJNYXhQbGF5ZXJzIjoxMCwiVHlwZSI6Ik5PTkUiLCJJbnZpdGVUaW1lb3V0IjozMDAsIkluYWN0aXZlVGltZW91dCI6MzAwLCJBdXRvSm9pbiI6dHJ1ZSwiZW5hYmxlU2VjcmV0IjpmYWxzZX0sIkNvbmZpZ3VyYXRpb25OYW1lIjoidGVzdEdhbWVTYW5pdHktYXV0b2pvaW4tMDFKOU5DRktHV1dUWEcwMDQ4RkNZTkFKUzMiLCJJc0Z1bGwiOmZhbHNlLCJMZWFkZXJJRCI6IjU5MWVlNmY2MzM1NjQ4YTM5MjA2ZTQzZmI3NTQ0YTYzIiwiVGVhbXMiOlt7InVzZXJJRHMiOlsiZjNmMGQyMDIyNTcxNDRlZThjNjZlNzVjMzJmNDc0MWQiLCI4YzhlNzdmOGRhNzc0YTI4YTMyMDQ5NzQ0MGIwYjg2ZCJdLCJwYXJ0aWVzIjpbeyJwYXJ0eUlEIjoiIiwidXNlcklEcyI6WyJmM2YwZDIwMjI1NzE0NGVlOGM2NmU3NWMzMmY0NzQxZCIsIjhjOGU3N2Y4ZGE3NzRhMjhhMzIwNDk3NDQwYjBiODZkIl19XX0seyJ1c2VySURzIjpbIjU5MWVlNmY2MzM1NjQ4YTM5MjA2ZTQzZmI3NTQ0YTYzIl0sInBhcnRpZXMiOlt7InBhcnR5SUQiOiIiLCJ1c2VySURzIjpbIjU5MWVlNmY2MzM1NjQ4YTM5MjA2ZTQzZmI3NTQ0YTYzIl19XX1dLCJEU0luZm9ybWF0aW9uIjp7IlNlcnZlciI6bnVsbCwiU3RhdHVzIjoiTkVFRF9UT19SRVFVRVNUIiwiU3RhdHVzVjIiOiJORUVEX1RPX1JFUVVFU1QifSwiQ29kZSI6IldDRDFRQiIsIlJlZHVjZVBheWxvYWRDb2RlIjpbMTAwMV19
sentAt: 2024-10-08T06:19:07Z

OnSessionStorageChanged

AGS Session will send the OnSessionStorageChanged notification to the game session members when:

• An admin or leader updates the leader storage.
• The system creates a game session with leader storage data.
• A member updates their session storage.

type: messageSessionNotif
topic: OnSessionStorageChanged
payload: eyJJc0xlYWRlciI6dHJ1ZSwiTmFtZXNwYWNlIjoic2FuaXR5dGVzdCIsIlNlc3Npb25JRCI6ImFiMjVlM2E2ZDU3NTQ4MGU5MTFiNjQ4YTdkZGJlYzEzIiwiU3RvcmFnZUNoYW5nZXMiOnsibGVhZGVyIjp7IkdBTUVfVkVSU0lPTiI6MTIzNCwiTUFQX05BTUUiOiJCQU5LIn19LCJBY3RvclVzZXJJRCI6ImNmZjY0ZTI3MDU3MjQwZGU4OTM2ZmEyMDcyN2U3YmExIn0
sentAt: 2024-10-08T07:18:05Z 

OnSessionNativePlatformSynced

AGS Session will send the OnSessionNativePlatformSynced notification to session (party or game) members when the first party session sync succeeds.

type: messageSessionNotif
topic: OnSessionNativePlatformSynced
payload: eyJQbGF0Zm9ybU5hbWUiOiJTVEVBTSIsIlBsYXRmb3JtU2Vzc2lvbklEIjoiMTA5Nzc1MjQyNjkyNzE3NjgwIiwiTmFtZXNwYWNlIjoiYWNjZWxieXRlIiwiU2Vzc2lvbklEIjoiYjExNGI5MWYwODk4NDQ3OGEzMmQ2ZGUxZjMzNTg2ZWIifQ
sentAt: 2024-10-08T06:34:56Z

OnDSStatusChanged

AGS Session will send the OnDSStatusChanged notification to the active members when there is a change in the dedicated server status (e.g., READY, AVAILABLE, etc). This is only applicable to game sessions.

type: messageSessionNotif
topic: OnDSStatusChanged
payload: eyJTZXNzaW9uSUQiOiJlY2M1YmNhOTMyZDY0YTNlYjk1ODViY2Y0NWExMjRkOSIsIkdhbWVTZXJ2ZXIiOnsic2Vzc2lvbl9pZCI6ImVjYzViY2E5MzJkNjRhM2ViOTU4NWJjZjQ1YTEyNGQ5IiwibmFtZXNwYWNlIjoic2FuaXR5dGVzdCIsInBvZF9uYW1lIjoiZHNfMTExMTExMTEtOTBmOS03YTI3LTExMTEtMGViOTUzMGVkOThmIiwiaW1hZ2VfdmVyc2lvbiI6ImltZ18xMTExMTExMS1iZmIwLTdiNGUtOWZkYi0xODRhMjJiNTdiYzIiLCJpcCI6IjE5Mi4xOTIuMTkyLjkxMiIsInBvcnQiOjIyMjIyLCJwcm90b2NvbCI6IlVEUCIsInBvcnRzIjp7ImRlZmF1bHQiOjIyMjIyfSwicHJvdmlkZXIiOiJBTVMiLCJnYW1lX3ZlcnNpb24iOiIiLCJzdGF0dXMiOiJSRUFEWSIsImxhc3RfdXBkYXRlIjoiMjAyNC0xMC0wN1QwOToyOTozNloiLCJkZXBsb3ltZW50Ijoic2FuaXR5X2ZsZWV0IiwicmVnaW9uIjoidXMtd2VzdC0yIiwiaXNfb3ZlcnJpZGVfZ2FtZV92ZXJzaW9uIjpmYWxzZSwiY3VzdG9tX2F0dHJpYnV0ZSI6InR0eDEucyIsInNvdXJjZSI6IkFNUyIsImFtc19wcm90b2NvbCI6W3sibmFtZSI6ImRlZmF1bHQiLCJwcm90b2NvbCI6IlVEUCJ9XX0sIlNlc3Npb24iOnsiSUQiOiJlY2M1YmNhOTMyZDY0YTNlYjk1ODViY2Y0NWExMjRkOSIsIk5hbWVzcGFjZSI6InNhbml0eXRlc3QiLCJNZW1iZXJzIjpbeyJJRCI6IjU2YjkyZTRlOGIxMjQwMzViNmJkNWRmYmY5ZTI1NjNjIiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA3VDA5OjI5OjM1LjYxMVoifSx7IklEIjoiMjk0ZjUyM2E5MjVjNGFiNGE4NDYwMDBiYzY3ZWUxOTQiLCJTdGF0dXMiOiJJTlZJVEVEIiwiU3RhdHVzVjIiOiJJTlZJVEVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wN1QwOToyOTozMi43MVoifV0sIkNyZWF0ZWRBdCI6IjIwMjQtMTAtMDdUMDk6Mjk6MzIuNzFaIiwiQ3JlYXRlZEJ5IjoiY2xpZW50LTVlZGFkYzdlMGJhMTQ3ZWFiMTAyMmQ1N2ExNjU2NjM4IiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wN1QwOToyOTozNS42NjRaIiwiVmVyc2lvbiI6MywiQ29uZmlndXJhdGlvbiI6eyJOYW1lIjoidGVzdEdhbWVTYW5pdHlBTVMtQ0xPU0VELTAxSjlLNFpISDZERDdWNFc1QlpTMERaMVdCIiwiSm9pbmFiaWxpdHkiOiJDTE9TRUQiLCJNaW5QbGF5ZXJzIjoxLCJNYXhQbGF5ZXJzIjoxMCwiUmVxdWVzdGVkUmVnaW9ucyI6WyJ1cy13ZXN0LTIiXSwiVHlwZSI6IkRTIiwiSW52aXRlVGltZW91dCI6MzAwLCJJbmFjdGl2ZVRpbWVvdXQiOjMwMCwiZW5hYmxlU2VjcmV0IjpmYWxzZX0sIkNvbmZpZ3VyYXRpb25OYW1lIjoidGVzdEdhbWVTYW5pdHlBTVMtQ0xPU0VELTAxSjlLNFpISDZERDdWNFc1QlpTMERaMVdCIiwiSXNGdWxsIjpmYWxzZSwiTGVhZGVySUQiOiI1NmI5MmU0ZThiMTI0MDM1YjZiZDVkZmJmOWUyNTYzYyIsIlRlYW1zIjpbeyJ1c2VySURzIjpbIjU2YjkyZTRlOGIxMjQwMzViNmJkNWRmYmY5ZTI1NjNjIl0sInBhcnRpZXMiOlt7InBhcnR5SUQiOiIiLCJ1c2VySURzIjpbIjU2YjkyZTRlOGIxMjQwMzViNmJkNWRmYmY5ZTI1NjNjIl19XX0seyJ1c2VySURzIjpbIjI5NGY1MjNhOTI1YzRhYjRhODQ2MDAwYmM2N2VlMTk0Il0sInBhcnRpZXMiOlt7InBhcnR5SUQiOiIiLCJ1c2VySURzIjpbIjI5NGY1MjNhOTI1YzRhYjRhODQ2MDAwYmM2N2VlMTk0Il19XX1dLCJEU0luZm9ybWF0aW9uIjp7IlNlcnZlciI6eyJzZXNzaW9uX2lkIjoiZWNjNWJjYTkzMmQ2NGEzZWI5NTg1YmNmNDVhMTI0ZDkiLCJuYW1lc3BhY2UiOiJzYW5pdHl0ZXN0IiwicG9kX25hbWUiOiJkc18xMTExMTExMS05MGY5LTdhMjctMTExMS0wZWI5NTMwZWQ5OGYiLCJpbWFnZV92ZXJzaW9uIjoiaW1nXzAxOTAzOTc3LWJmYjAtN2I0ZS05ZmRiLTE4NGEyMmI1N2JjMiIsImlwIjoiMTkyLjE5Mi4xOTIuMTkyIiwicG9ydCI6MjIyMjIsInByb3RvY29sIjoiVURQIiwicG9ydHMiOnsiZGVmYXVsdCI6MjIyMjJ9LCJwcm92aWRlciI6IkFNUyIsImdhbWVfdmVyc2lvbiI6IiIsInN0YXR1cyI6IlJFQURZIiwibGFzdF91cGRhdGUiOiIyMDI0LTEwLTA3VDA5OjI5OjM2WiIsImRlcGxveW1lbnQiOiJzYW5pdHlfZmxlZXQiLCJyZWdpb24iOiJ1cy13ZXN0LTIiLCJpc19vdmVycmlkZV9nYW1lX3ZlcnNpb24iOmZhbHNlLCJjdXN0b21fYXR0cmlidXRlIjoidHR4MS5zIiwic291cmNlIjoiQU1TIiwiYW1zX3Byb3RvY29sIjpbeyJuYW1lIjoiZGVmYXVsdCIsInByb3RvY29sIjoiVURQIn1dfSwiUmVxdWVzdGVkQXQiOiIyMDI0LTEwLTA3VDA5OjI5OjM1LjYwMVoiLCJTdGF0dXMiOiJBVkFJTEFCTEUiLCJTdGF0dXNWMiI6IkFWQUlMQUJMRSJ9LCJNYXRjaFBvb2wiOiJ0ZXN0TWF0Y2hQb29sQU1TLUNMT1NFRC0wMUo5SzRaSEg2REQ3VjRXNUMwMTlDQTQ5MSIsIkdhbWVNb2RlIjoidGVzdE1hdGNoUG9vbEFNUy1DTE9TRUQtMDFKOUs0WkhINkREN1Y0VzVDMDE5Q0E0OTEifSwiUmVkdWNlUGF5bG9hZENvZGUiOlsxMDAxXX0
sentAt: 2024-10-07T09:29:35Z
sequenceID: 1728293364
sequenceNumber: 6 

OnSessionJoinedSecret

AGS Session will send the OnSessionJoinedSecret notification to the game session members when the session type is DS (dedicated server) and the secret validation is being enabled.

type: messageSessionNotif
topic: OnSessionJoinedSecret
payload: eyJzZWNyZXQiOiJjZDUwY2M1MTc2ZWE5NzkwNGFiYTExNmIxZGQ1MmY1ZDA3ZTQ0ZWEzIn0
sentAt: 2024-10-08T08:08:45Z 

Party session

The following sections outline notifications related to party sessions.

OnPartyCreated

AGS Session will send the OnPartyCreated notification to a user who requested a party creation upon success.

type: messageSessionNotif
topic: OnPartyCreated
payload: eyJDcmVhdGVkQnkiOiI1ZGNkYzg1NjZjYmY0Yjg1OTM4M2YwZWRmZmM3MTQ1YSIsImluYWN0aXZlVGltZW91dCI6MzAwLCJQYXJ0eUlEIjoiMWY4NzdkN2RjOGI5NDQ4YTgxZmUxMTYzMGQ5NzRhZWIiLCJUZXh0Q2hhdCI6ZmFsc2UsIkNvZGUiOiJDVE0yRloifQ
sentAt: 2024-10-08T12:21:05Z
sequenceID: 1728390055
sequenceNumber: 2 

OnPartyInvited

AGS Session will send the OnPartyInvited notification to user who is being invited to the party session.

type: messageSessionNotif
topic: OnPartyInvited
payload: eyJTZW5kZXJJRCI6IjVkY2RjODU2NmNiZjRiODU5MzgzZjBlZGZmYzcxNDVhIiwiUGFydHlJRCI6IjFmODc3ZDdkYzhiOTQ0OGE4MWZlMTE2MzBkOTc0YWViIiwiQ29kZSI6IkNUTTJGWiIsIkV4cGlyZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjY6MDUuNTQ0MTQzMzU4WiJ9
sentAt: 2024-10-08T12:21:05Z 

OnPartyMembersChanged

AGS Session will send the OnPartyMembersChanged notification to the active party session members when there is a change in the member status (e.g., JOINED, DISCONNECTED, LEFT, etc.). The AGS Game SDK will listen for this message and parse the version information data to be stored in the local cache.

type: messageSessionNotif
topic: OnPartyMembersChanged
payload: eyJMZWFkZXJJRCI6IjYyNTNmZmFlM2RjZDRkYjZiNzYwZmQ2OTkzODQ5OWM5IiwiUGFydHlJRCI6IjFmODc3ZDdkYzhiOTQ0OGE4MWZlMTE2MzBkOTc0YWViIiwiVGV4dENoYXQiOmZhbHNlLCJJbXBhY3RlZFVzZXJJRHMiOnsiS2lja2VkVXNlcklEcyI6WyI1ZGNkYzg1NjZjYmY0Yjg1OTM4M2YwZWRmZmM3MTQ1YSJdfSwiU2Vzc2lvbiI6eyJJRCI6IjFmODc3ZDdkYzhiOTQ0OGE4MWZlMTE2MzBkOTc0YWViIiwiTmFtZXNwYWNlIjoic2FuaXR5dGVzdCIsIk1lbWJlcnMiOlt7IklEIjoiZmQxNjk1Mzg3NDM0NGJlMjk1YTJlZjViZGE4ZjJmZTgiLCJTdGF0dXMiOiJSRUpFQ1RFRCIsIlN0YXR1c1YyIjoiUkVKRUNURUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjIxOjA2Ljk2NFoifSx7IklEIjoiNjI1M2ZmYWUzZGNkNGRiNmI3NjBmZDY5OTM4NDk5YzkiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjE6MDYuMzM3WiJ9LHsiSUQiOiI1YjM5MzdhMjI3MmI0MTRhYjNiZDJlOGU3OTQ4NTUyYiIsIlN0YXR1cyI6IkpPSU5FRCIsIlN0YXR1c1YyIjoiSk9JTkVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjoyMTowNi42NzZaIn0seyJJRCI6IjVkY2RjODU2NmNiZjRiODU5MzgzZjBlZGZmYzcxNDVhIiwiU3RhdHVzIjoiS0lDS0VEIiwiU3RhdHVzVjIiOiJLSUNLRUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjIxOjA4LjAxNloifV0sIkF0dHJpYnV0ZXMiOnsicHJlZmVyZW5jZSI6eyJjcm9zc3BsYXlfZW5hYmxlZCI6ZmFsc2UsImN1cnJlbnRfcGxhdGZvcm0iOiJhY2NlbGJ5dGUiLCJzaW11bHRhbmVvdXNfcGxhdGZvcm0iOiIifX0sIkNyZWF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjE6MDUuNDg2WiIsIkNyZWF0ZWRCeSI6IjVkY2RjODU2NmNiZjRiODU5MzgzZjBlZGZmYzcxNDVhIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjoyMTowOC4wMTZaIiwiVmVyc2lvbiI6NiwiQ29uZmlndXJhdGlvbiI6eyJOYW1lIjoidGVzdHRlc3RQYXJ0eVNhbml0eS1JTlZJVEUtMDFKOVAxNkQwODY4UEtaUFFGV0VXVlFBOTgiLCJKb2luYWJpbGl0eSI6IklOVklURV9PTkxZIiwiTWluUGxheWVycyI6MSwiTWF4UGxheWVycyI6MTAsIlR5cGUiOiJOT05FIiwiSW52aXRlVGltZW91dCI6MzAwLCJJbmFjdGl2ZVRpbWVvdXQiOjMwMCwiZW5hYmxlU2VjcmV0IjpmYWxzZX0sIkNvbmZpZ3VyYXRpb25OYW1lIjoidGVzdHRlc3RQYXJ0eVNhbml0eS1JTlZJVEUtMDFKOVAxNkQwODY4UEtaUFFGV0VXVlFBOTgiLCJJc0Z1bGwiOmZhbHNlLCJMZWFkZXJJRCI6IjYyNTNmZmFlM2RjZDRkYjZiNzYwZmQ2OTkzODQ5OWM5IiwiQ29kZSI6IkNUTTJGWiJ9LCJSZWR1Y2VQYXlsb2FkQ29kZSI6WzEwMDFdfQ
sentAt: 2024-10-08T12:21:08Z 

OnPartyJoined

AGS Session will send the OnPartyJoined notification to the user who joins the party session from an invitation.

topic: OnPartyJoined
payload: eyJNZW1iZXJzIjpbeyJJRCI6ImZkMTY5NTM4NzQzNDRiZTI5NWEyZWY1YmRhOGYyZmU4IiwiU3RhdHVzIjoiSU5WSVRFRCIsIlN0YXR1c1YyIjoiSU5WSVRFRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjE6MDUuNDg2WiJ9LHsiSUQiOiI2MjUzZmZhZTNkY2Q0ZGI2Yjc2MGZkNjk5Mzg0OTljOSIsIlN0YXR1cyI6IkpPSU5FRCIsIlN0YXR1c1YyIjoiSk9JTkVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjoyMTowNi4zMzdaIn0seyJJRCI6IjViMzkzN2EyMjcyYjQxNGFiM2JkMmU4ZTc5NDg1NTJiIiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjIxOjA2LjY3NloifSx7IklEIjoiNWRjZGM4NTY2Y2JmNGI4NTkzODNmMGVkZmZjNzE0NWEiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjE6MDUuNDg2WiJ9XSwiUGFydHlJRCI6IjFmODc3ZDdkYzhiOTQ0OGE4MWZlMTE2MzBkOTc0YWViIiwiVGV4dENoYXQiOmZhbHNlLCJDb2RlIjoiQ1RNMkZaIn0
sentAt: 2024-10-08T12:21:06Z 

OnPartyRejected

AGS Session will send the OnPartyRejected notification to the active session members when there is a party session invitation that has been rejected by the invited player.

type: messageSessionNotif
topic: OnPartyRejected
payload: eyJNZW1iZXJzIjpbeyJJRCI6ImZkMTY5NTM4NzQzNDRiZTI5NWEyZWY1YmRhOGYyZmU4IiwiU3RhdHVzIjoiUkVKRUNURUQiLCJTdGF0dXNWMiI6IlJFSkVDVEVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjoyMTowNi45NjRaIn0seyJJRCI6IjYyNTNmZmFlM2RjZDRkYjZiNzYwZmQ2OTkzODQ5OWM5IiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjIxOjA2LjMzN1oifSx7IklEIjoiNWIzOTM3YTIyNzJiNDE0YWIzYmQyZThlNzk0ODU1MmIiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjE6MDYuNjc2WiJ9LHsiSUQiOiI1ZGNkYzg1NjZjYmY0Yjg1OTM4M2YwZWRmZmM3MTQ1YSIsIlN0YXR1cyI6IkpPSU5FRCIsIlN0YXR1c1YyIjoiSk9JTkVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjoyMTowNS40ODZaIn1dLCJQYXJ0eUlEIjoiMWY4NzdkN2RjOGI5NDQ4YTgxZmUxMTYzMGQ5NzRhZWIiLCJSZWplY3RlZElEIjoiZmQxNjk1Mzg3NDM0NGJlMjk1YTJlZjViZGE4ZjJmZTgifQ
sentAt: 2024-10-08T12:21:07Z 

OnPartyCancelled

AGS Session will send the OnPartyCancelled notification to the invited user when the inviter cancels the party session invitation.

type: messageSessionNotif
topic: OnPartyCancelled
payload: eyJNZW1iZXJzIjpbeyJJRCI6ImY5NzE0ZjMxZDQ3ZTQzNjJhZDAxZDY1MjU3MzI4MDUzIiwiU3RhdHVzIjoiQ0FOQ0VMTEVEIiwiU3RhdHVzVjIiOiJDQU5DRUxMRUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjQ0OjI3LjI4N1oifSx7IklEIjoiNDVlZjc1ZWIwY2M2NDMyNWJjMDg5MWI0NTEyZjM4NDgiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6NDQ6MjYuNDk5WiJ9LHsiSUQiOiIzZWU3ZmEwOWMxMzA0OTM0ODdhZTYwMjVhZDQwZGYxYiIsIlN0YXR1cyI6IkpPSU5FRCIsIlN0YXR1c1YyIjoiSk9JTkVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjo0NDoyNi43ODRaIn0seyJJRCI6IjE5OTI5MWU5MGRhZTRiMzU5MDVhMTM5ZTMwNDY4OTg1IiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjQ0OjI1LjczOVoifV0sIlBhcnR5SUQiOiI3MDJiYTExYTJlYzc0M2Y1YWQ1OGNjMWIzM2U2MzM3YiIsIkNhbmNlbGxlZFVzZXJJRHMiOlsiZjk3MTRmMzFkNDdlNDM2MmFkMDFkNjUyNTczMjgwNTMiXX0
sentAt: 2024-10-08T12:44:27Z

OnPartyUpdated

AGS Session will send the OnPartyUpdated notification to all active members when there is a change in the party session data, including the session attribute, configuration, and leader status.

topic: OnPartyUpdated
payload: eyJJRCI6IjFmODc3ZDdkYzhiOTQ0OGE4MWZlMTE2MzBkOTc0YWViIiwiTmFtZXNwYWNlIjoic2FuaXR5dGVzdCIsIk1lbWJlcnMiOlt7IklEIjoiZmQxNjk1Mzg3NDM0NGJlMjk1YTJlZjViZGE4ZjJmZTgiLCJTdGF0dXMiOiJSRUpFQ1RFRCIsIlN0YXR1c1YyIjoiUkVKRUNURUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjIxOjA2Ljk2NFoifSx7IklEIjoiNjI1M2ZmYWUzZGNkNGRiNmI3NjBmZDY5OTM4NDk5YzkiLCJTdGF0dXMiOiJKT0lORUQiLCJTdGF0dXNWMiI6IkpPSU5FRCIsIlVwZGF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjE6MDYuMzM3WiJ9LHsiSUQiOiI1YjM5MzdhMjI3MmI0MTRhYjNiZDJlOGU3OTQ4NTUyYiIsIlN0YXR1cyI6IkpPSU5FRCIsIlN0YXR1c1YyIjoiSk9JTkVEIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjoyMTowNi42NzZaIn0seyJJRCI6IjVkY2RjODU2NmNiZjRiODU5MzgzZjBlZGZmYzcxNDVhIiwiU3RhdHVzIjoiSk9JTkVEIiwiU3RhdHVzVjIiOiJKT0lORUQiLCJVcGRhdGVkQXQiOiIyMDI0LTEwLTA4VDEyOjIxOjA1LjQ4NloifV0sIkF0dHJpYnV0ZXMiOnsicHJlZmVyZW5jZSI6eyJjcm9zc3BsYXlfZW5hYmxlZCI6ZmFsc2UsImN1cnJlbnRfcGxhdGZvcm0iOiJhY2NlbGJ5dGUiLCJzaW11bHRhbmVvdXNfcGxhdGZvcm0iOiIifX0sIkNyZWF0ZWRBdCI6IjIwMjQtMTAtMDhUMTI6MjE6MDUuNDg2WiIsIkNyZWF0ZWRCeSI6IjVkY2RjODU2NmNiZjRiODU5MzgzZjBlZGZmYzcxNDVhIiwiVXBkYXRlZEF0IjoiMjAyNC0xMC0wOFQxMjoyMTowNy43MDNaIiwiVmVyc2lvbiI6NSwiQ29uZmlndXJhdGlvbiI6eyJOYW1lIjoidGVzdHRlc3RQYXJ0eVNhbml0eS1JTlZJVEUtMDFKOVAxNkQwODY4UEtaUFFGV0VXVlFBOTgiLCJKb2luYWJpbGl0eSI6IklOVklURV9PTkxZIiwiTWluUGxheWVycyI6MSwiTWF4UGxheWVycyI6MTAsIlR5cGUiOiJOT05FIiwiSW52aXRlVGltZW91dCI6MzAwLCJJbmFjdGl2ZVRpbWVvdXQiOjMwMCwiZW5hYmxlU2VjcmV0IjpmYWxzZX0sIkNvbmZpZ3VyYXRpb25OYW1lIjoidGVzdHRlc3RQYXJ0eVNhbml0eS1JTlZJVEUtMDFKOVAxNkQwODY4UEtaUFFGV0VXVlFBOTgiLCJJc0Z1bGwiOmZhbHNlLCJMZWFkZXJJRCI6IjYyNTNmZmFlM2RjZDRkYjZiNzYwZmQ2OTkzODQ5OWM5IiwiQ29kZSI6IkNUTTJGWiIsIlJlZHVjZVBheWxvYWRDb2RlIjpbMTAwMV19
sentAt: 2024-10-08T12:21:07Z 

OnPartyInviteTimeout

AGS Session will send the OnPartyInviteTimeout notification to the user who is being invited to the party session, but failed to join within the invitation timeout period.

type: messageSessionNotif
topic: OnPartyInviteTimeout
payload: eyJQYXJ0eUlEIjoiMWY4NzdkN2RjOGI5NDQ4YTgxZmUxMTYzMGQ5NzRhZWIifQ
sentAt: 2024-10-08T12:50:27Z

OnPartyKicked

AGS Session will send the OnPartyKicked notification to the member who is being kicked from the party session because of a party put/patch operation, the leader has kicked the player, or a kick operation by the system.

type: messageSessionNotif
topic: OnPartyKicked
payload: eyJQYXJ0eUlEIjoiMWY4NzdkN2RjOGI5NDQ4YTgxZmUxMTYzMGQ5NzRhZWIifQ
sentAt: 2024-10-08T12:21:08Z

Lobby

The following sections outline notifications related to lobbies.

connectNotif

AGS Lobby will send the connectNotif notification to a user when they successfully connect to the Lobby WebSocket.

type: connectNotif
loginType: NewRegister
reconnectFromCode: 5000
lobbySessionID: bb0c23efbad24ee0bd99bdefe4dbfbf4
sequenceID: 1727957515
sequenceNumber: 1

requestFriendsNotif

AGS Lobby will send the requestFriendsNotif notification to the user when there is a friend request operation.

type: requestFriendsNotif
friendId: c3720a28994b49c883023781f11471ab

acceptFriendsNotif

AGS Lobby will send the acceptFriendsNotif notification to the users when their friend request has been accepted.

type: acceptFriendsNotif
friendId: 62ca724cd63b4052be9812935ba9a663

rejectFriendsNotif

AGS Lobby will send the rejectFriendsNotif notification to users when their friend request has been rejected.

type: rejectFriendsNotif
userId: 16b7d8a27b514e909a06389e975f5f96

cancelFriendsNotif

AGS Lobby will send the cancelFriendsNotif notification to the user when the requesters cancel their friend request.

type: cancelFriendsNotif
userId: 54b0f84843ea492caced6b2d948ee426

unfriendNotif

AGS Lobby will send the unfriendNotif notification to the users when the other user unfriends them.

type: unfriendNotif
friendId: c3720a28994b49c883023781f11471ab