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-channelsHeaders
None available
Route params
None available
Query keys
| Key | Required | Description |
|---|---|---|
page | ✅ Yes | 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/subscriptionsHeaders
| 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/:idHeaders
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/membersHeaders
None available
Route params
| Key | Required | Description |
|---|---|---|
id | ✅ Yes | The ID of the channel |
Query keys
None available
Sample response
{ ... }
Create a game channel
POST https://api.trytalo.com/v1/game-channelsSample request
{ ... }
Sample response
{ ... }
Join a game channel
POST https://api.trytalo.com/v1/game-channels/:id/joinSample response
{ ... }
Leave a game channel
POST https://api.trytalo.com/v1/game-channels/:id/leaveInvite another player to a game channel
POST https://api.trytalo.com/v1/game-channels/:id/inviteUpdate a game channel
PUT https://api.trytalo.com/v1/game-channels/:idSample request
{ ... }
Sample response
{ ... }
Delete a game channel
DELETE https://api.trytalo.com/v1/game-channels/:idTypes
Prop
type Prop = {
key: string
value: string | null
}