GetChannel
Jump to navigation
Jump to search
Description
Return a specific Channel object. Could be a Root Channel or any sub channel valid and active on the Instance configuration. This method can be accessed with a valid logged token or anonymous.
It automatically filters the results to return only enable channel in the Instance, including the adult channels.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- channelId (int, required)
- Id of the channel that wants to return the object information.
Returns
Returns a JSON object containing an object of Channel.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "Content":
- { Channel object }
}
Exceptions
Caching
This method is cached.
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |