Authenticating The Request
No authentication is required for calling this end point, however if the request is being made by a signed in player it is recommended to pass in a sessionKey parameter as the request response will return additional information useful to the player.
- sessionKey string Optional
- The session key of the player who is currently signed in and making this request.
Request Parameters
- gameID guid Required
- The ID of the game you are making this request against. You can find the ID of your game in your Construct Game Services (CGS) account.
- channelID guid Required
- The ID of the channel you want to retrieve.
- requestedLanguage Language Optional
- Optionally specify a language for returning translatable properties into this language. If not specified, your games default language will be used.
- culture string Optional
- Optionally specify a supported culture code for rendering various properties. If not specified, the
requestedLanguage default culture code will be used.
Success Response
Successful responses always return a HTTP 200 status code.
{
"success": true,
"channel": { ... },
"formattingCulture": "en-us"
}
Response Properties
- success bool
- If the request was successfull or not.
- channel BroadcastChannel
- The channel object returned from the request.
- formattingCulture string
- If some return values are culture specific, this property indicates what culture the values have been rendered as.
Failure Response
Unsuccessful responses always return HTTP 4xx status codes.
{
"success": false,
"errorMessage": "Your request failed due to...",
"helpURL": "https://www.construct.net/en/game-services/manuals/game-services/broadcasts/api-end-points/channels/get-channel",
"shouldRetry": false
}
Response Properties
- success bool
- If the request was successfull or not.
- errorMessage string
- An error message with more detailed information on why the request failed.
- helpURL url (string)
- A link to documentation which should provide help with the error.
- shouldRetry bool
- Should the client wait a short period of time and retry the request. Usually this is false, but returns true if the request failed due to rate limiting.