Game channel API

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-channels

Headers

None available

Route params

None available

Query keys

Key	Required	Description
`page`	❌ No	The current pagination index (starting at 0)

Sample response

{ ... }

Sample request with prop key filtering

{ ... }

Sample request with prop key and value filtering

{ ... }

List game channels that the player is subscribed to

read:gameChannels

GET https://api.trytalo.com/v1/game-channels/subscriptions

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

None available

Query keys

Key	Required	Description
`propKey`	❌ No	Only return channels with this prop key
`propValue`	❌ No	Only return channels with a matching prop key and value

Sample response

{ ... }

Sample request with prop key filtering

{ ... }

Sample request with prop key and value filtering

{ ... }

Find a game channel

read:gameChannels

GET https://api.trytalo.com/v1/game-channels/:id

Headers

None available

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

Key	Required	Description
`propKey`	❌ No	Only return channels with this prop key
`propValue`	❌ No	Only return channels with a matching prop key and value

Sample response

{ ... }

Get the members of a game channel

read:gameChannels

GET https://api.trytalo.com/v1/game-channels/:id/members

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

Key	Required	Description
`aliasId`	❌ No	Find a member with this player alias ID
`identifier`	❌ No	Find a member with this identifier
`page`	❌ No	The current pagination index (starting at 0)
`playerGroupId`	❌ No	Filter members by players in this group
`playerId`	❌ No	Filter members by this player ID
`playerPropKey`	❌ No	Filter members by players with this prop key
`playerPropValue`	❌ No	Filter members by players with matching prop keys and values

Sample response

{ ... }

Get a single storage property from a game channel

read:gameChannels

GET https://api.trytalo.com/v1/game-channels/:id/storage

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

Key	Required	Description
`propKey`	✅ Yes	The key of the storage property to retrieve

Sample response

{ ... }

Sample response when property does not exist

{ ... }

Get multiple storage properties from a game channel

read:gameChannels

GET https://api.trytalo.com/v1/game-channels/:id/storage/list

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

Key	Required	Description
`propKeys`	✅ Yes	An array of storage property keys to retrieve (maximum 50 keys)

Sample request

{ ... }

Sample response

{ ... }

Create a game channel

write:gameChannels

POST https://api.trytalo.com/v1/game-channels

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

None available

Query keys

None available

Body keys

Key	Required	Description
`autoCleanup`	❌ No	Whether the channel should be automatically deleted when the owner leaves or the channel is empty (default is false)
`name`	✅ Yes	The name of the channel
`private`	❌ No	Private channels require invites to join them (default is false)
`props`	❌ No	An array of Props

Sample request

{ ... }

Sample response

{ ... }

Join a game channel

write:gameChannels

POST https://api.trytalo.com/v1/game-channels/:id/join

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

None available

Body keys

None available

Sample response

{ ... }

Leave a game channel

write:gameChannels

POST https://api.trytalo.com/v1/game-channels/:id/leave

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

None available

Body keys

None available

Invite another player to a game channel

write:gameChannels

POST https://api.trytalo.com/v1/game-channels/:id/invite

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

None available

Body keys

Key	Required	Description
`inviteeAliasId`	❌ No	The ID of the player alias to invite

Update a game channel

write:gameChannels

PUT https://api.trytalo.com/v1/game-channels/:id

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

None available

Body keys

Key	Required	Description
`autoCleanup`	❌ No	Whether the channel should be automatically deleted when the owner leaves or the channel is empty (default is false)
`name`	❌ No	The new name of the channel
`ownerAliasId`	❌ No	The ID of the new owner of the channel
`private`	❌ No	Private channels require invites to join them (default is false)
`props`	❌ No	An array of Props

Sample request

{ ... }

Sample response

{ ... }

Create or update storage properties in a game channel

write:gameChannels

PUT https://api.trytalo.com/v1/game-channels/:id/storage

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

None available

Body keys

Key	Required	Description
`props`	✅ Yes	An array of storage properties to create or update. Set value to null to delete a property.

Sample request to create/update properties

{ ... }

Sample request to delete a property

{ ... }

Sample response

{ ... }

Sample response with deletion

{ ... }

Delete a game channel

write:gameChannels

DELETE https://api.trytalo.com/v1/game-channels/:id

Headers

Key	Required	Description
`x-talo-alias`	✅ Yes	The ID of the player's alias

Route params

Key	Required	Description
`id`	✅ Yes	The ID of the channel

Query keys

None available

Body keys

None available

Types

Prop

type Prop = {
  key: string
  value: string | null
}

Endpoints​

List game channels​

Headers​

Route params​

Query keys​

Sample response

Sample request with prop key filtering

Sample request with prop key and value filtering

List game channels that the player is subscribed to​

Headers​

Route params​

Query keys​

Sample response

Sample request with prop key filtering

Sample request with prop key and value filtering

Find a game channel​

Headers​

Route params​

Query keys​

Sample response

Get the members of a game channel​

Headers​

Route params​

Query keys​

Sample response

Get a single storage property from a game channel​

Headers​

Route params​

Query keys​

Sample response

Sample response when property does not exist

Get multiple storage properties from a game channel​

Headers​

Route params​

Query keys​

Sample request

Sample response

Create a game channel​

Headers​

Route params​

Query keys​

Body keys​

Sample request

Sample response

Join a game channel​

Headers​

Route params​

Query keys​

Body keys​

Sample response

Leave a game channel​

Headers​

Route params​

Query keys​

Body keys​

Invite another player to a game channel​

Headers​

Route params​

Query keys​

Body keys​

Update a game channel​

Headers​

Route params​

Query keys​

Body keys​

Sample request

Sample response

Create or update storage properties in a game channel​

Headers​

Route params​

Query keys​

Body keys​

Sample request to create/update properties

Sample request to delete a property

Sample response

Sample response with deletion

Delete a game channel​

Headers​

Route params​

Query keys​

Endpoints

List game channels

Headers

Route params

Query keys

List game channels that the player is subscribed to

Headers

Route params

Query keys

Find a game channel

Headers

Route params

Query keys

Get the members of a game channel

Headers

Route params

Query keys

Get a single storage property from a game channel

Headers

Route params

Query keys

Get multiple storage properties from a game channel

Headers

Route params

Query keys

Create a game channel

Headers

Route params

Query keys

Body keys

Join a game channel

Headers

Route params

Query keys

Body keys

Leave a game channel

Headers

Route params

Query keys

Body keys

Invite another player to a game channel

Headers

Route params

Query keys

Body keys

Update a game channel

Headers

Route params

Query keys

Body keys

Create or update storage properties in a game channel

Headers

Route params

Query keys

Body keys

Delete a game channel

Headers

Route params

Query keys

Body keys

Types

Prop