channels.getChannelInfo

Syntax

array channels.getChannelInfo ( mixed id, int vhost = NULL )

Argument Info

NameTypeRequiredDefault valueDescription
idmixedRequirednoneThe ID of the channel you want information about.
vhostintOptionalNULLThe vhost ID that the channel belongs to.

Return Values

FieldDescriptionPossible Values
idachannel idbN/A
nameachannelnamebN/A
createdacreationdatebN/A
groupidathe id of the parent channel, if any (depreciated)bN/A
groupnameathe name of the parent channel (deprecated)bN/A
parentchannelathe id of the parent channel, if anybN/A
descriptionadescription for the channelbN/A
geoblockingaeach item is a country code that is allowed to view the media item, if empty then all countries may view the mediabN/A
visibilitya"SHOWN or "HIDDEN". Hiding a channel does not make the media within private, hidden or otherwise inaccessible.bN/A