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

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

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

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

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

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

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

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

{ ... }

---

Create or update storage properties in a game channel

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

Sample request to create/update properties

{ ... }

Sample request to delete a property

{ ... }

Sample response

{ ... }

Sample response with deletion

{ ... }

---

Delete a game channel

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

---

Types

Prop

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