Skip to main content

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

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

Headers

None available

Route params

None available

Query keys

KeyRequiredDescription
page YesThe 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

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

Headers

KeyRequiredDescription
x-talo-alias YesThe ID of the player's alias

Route params

None available

Query keys

KeyRequiredDescription
propKey NoOnly return channels with this prop key
propValue NoOnly 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

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

Headers

None available

Route params

KeyRequiredDescription
id YesThe ID of the channel

Query keys

KeyRequiredDescription
propKey NoOnly return channels with this prop key
propValue NoOnly return channels with a matching prop key and value

Sample response

{ ... }

Get the members of a game channel

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

Headers

None available

Route params

KeyRequiredDescription
id YesThe ID of the channel

Query keys

None available

Sample response

{ ... }

Create a game channel

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

Sample request

{ ... }

Sample response

{ ... }

Join a game channel

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

Sample response

{ ... }

Leave a game channel

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

Invite another player to a game channel

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

Update a game channel

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

Sample request

{ ... }

Sample response

{ ... }

Delete a game channel

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

Types

Prop

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