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

Query keys

Key	Required	Description
page	✅ Yes	The current pagination index (starting at 0)

Sample response

{ ... }

---

List game channels that the player is subscribed to

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

Headers

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

Sample response

{ ... }

---

Find a game channel

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

Route params

Key	Required	Description
id	✅ Yes	The ID of the channel

Sample response

{ ... }

---

Create a game channel

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

Headers

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

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
props	❌ No	An array of Props

Sample request

{ ... }

Sample response

{ ... }

---

Join a game channel

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

Sample request

{ ... }

Sample response

{ ... }

---

Leave a game channel

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

---

Update a game channel

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

Body keys

Key	Required	Description
name	❌ No	The new name of the channel
ownerAliasId	❌ No	The ID of the new owner of the channel
props	❌ No	An array of Props

Sample request

{ ... }

Sample response

{ ... }

---

Delete a game channel

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

---

Types

Prop

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