Channels are a way to send messages between players in your game. You can use channels to create chat rooms, send notifications or create any other kind of messaging system you can think of.
Learn more about channels here .
Endpoints
List game channels read:gameChannels
GET https://api.trytalo.com/v1/game-channelsQuery keys Key Required Description page❌ NoThe current pagination index (starting at 0) propKey❌ NoOnly return channels with this prop key propValue❌ NoOnly return channels with a matching prop key and value search❌ NoSearch term to filter channels by name
Sample response Show
Sample request with prop key filtering Show
Sample request with prop key and value filtering Show List game channels that the player is subscribed to read:gameChannels
GET https://api.trytalo.com/v1/game-channels/subscriptionsKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Query keys Key Required Description propKey❌ NoOnly return channels with this prop key propValue❌ NoOnly return channels with a matching prop key and value
Sample response Show
Sample request with prop key filtering Show
Sample request with prop key and value filtering Show Get the members of a game channel read:gameChannels
GET https://api.trytalo.com/v1/game-channels/:id/membersKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Query keys Key Required Description aliasId❌ NoFind a member with this player alias ID identifier❌ NoFind a member with this identifier page❌ NoThe current pagination index (starting at 0) playerGroupId❌ NoFilter members by players in this group playerId❌ NoFilter members by this player ID playerPropKey❌ NoFilter members by players with this prop key playerPropValue❌ NoFilter members by players with matching prop keys and values
Sample response Show Get multiple storage properties from a game channel read:gameChannels
GET https://api.trytalo.com/v1/game-channels/:id/storage/listKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Query keys Key Required Description propKeys✅ YesAn array of storage property keys to retrieve (maximum 50 keys)
Sample request Show
Sample response Show Get a single storage property from a game channel read:gameChannels
GET https://api.trytalo.com/v1/game-channels/:id/storageKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Query keys Key Required Description propKey✅ YesThe key of the storage property to retrieve
Sample response Show
Sample response when property does not exist Show Find a game channel read:gameChannels
GET https://api.trytalo.com/v1/game-channels/:idRoute params Key Required Description id✅ YesThe ID of the channel
Sample response Show Create a game channel write:gameChannels
POST https://api.trytalo.com/v1/game-channelsKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Body keys Key Required Description autoCleanup❌ NoWhether the channel should be automatically deleted when the owner leaves or the channel is empty (default is false) name✅ YesThe name of the channel private❌ NoPrivate channels require invites to join them (default is false) props❌ NoAn array of Props temporaryMembership❌ NoWhether members should be removed when they disconnect (default is false)
Sample request Show
Sample response Show Join a game channel write:gameChannels
POST https://api.trytalo.com/v1/game-channels/:id/joinKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Sample response Show Leave a game channel write:gameChannels
POST https://api.trytalo.com/v1/game-channels/:id/leaveKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Invite another player to a game channel write:gameChannels
POST https://api.trytalo.com/v1/game-channels/:id/inviteKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Body keys Key Required Description inviteeAliasId✅ YesThe ID of the player alias to invite
Create or update storage properties in a game channel. write:gameChannels
PUT https://api.trytalo.com/v1/game-channels/:id/storageThe failedProps array contains props that were rejected due to size constraints or because their values contain profanity (when profanity blocking is enabled).
Key Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Body keys Key Required Description props✅ YesAn array of storage properties to create or update. Set value to null to delete a property.
Sample request to create/update properties Show
Sample request to delete a property Show
Sample response Show Update a game channel write:gameChannels
PUT https://api.trytalo.com/v1/game-channels/:idKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Body keys Key Required Description autoCleanup❌ NoWhether the channel should be automatically deleted when the owner leaves or the channel is empty (default is false) name❌ NoThe new name of the channel ownerAliasId❌ NoThe ID of the new owner of the channel private❌ NoPrivate channels require invites to join them (default is false) props❌ NoAn array of Props temporaryMembership❌ NoWhether members should be removed when they disconnect (default is false)
Sample request Show
Sample response Show Delete a game channel write:gameChannels
DELETE https://api.trytalo.com/v1/game-channels/:idKey Required Description x-talo-alias✅ YesThe ID of the player's alias
Route params Key Required Description id✅ YesThe ID of the channel
Types
Prop
type Prop = {
key : string
value : string | null
}