Docs
  • Overview
    • Philosophy
    • Versioning
  • Delivery API
    • Introduction
    • Channels
  • Management API
    • Introduction
Powered by GitBook
On this page
  1. Delivery API

Channels

Here you can find all endpoints that retrieves channels data.

PreviousIntroductionNextIntroduction

Last updated 1 year ago

Getting channel data

By making this request you will get your channel data in different formats, right now this request is mainly used to integrate your channel in Roku.

Returns the channel atributes.

get
Path parameters
channel_idstringRequired

Represents the channel id, it is composed by 32 hexadecimal characters. Where can I find the channel ID? You can find your channel id on your dashboard, click over the channel name and the ID will be copied on your by editing your channel and getting it from the url.

Example: {"summary":"Channel identificator","value":"a68a72d5abdb040c7b279c707ed5477e"}
Query parameters
formatstring · enumOptional

Return format for the response, the default value is json. If you want to use the response in Direct Publisher in Roku, you must use roku_json.

Default: jsonExample: {"summary":"Return format for the response, must be one of this: json, roku_json. Default value: json","value":"json"}Possible values:
Responses
200
It will return the channel in the format specified, for roku_json the response is compatible with Direct Publisher in Roku.
application/json
ResponsestringExample: The body depends on the format param
404
The channel defined by the id in the path was not found
application/json
get
GET /channel/{channel_id} HTTP/1.1
Host: deliver.viloud.tv
Accept: */*
The body depends on the format param

Returns the channel content

get
Path parameters
channel_idstringRequired

Represents the channel id, it is composed by 32 hexadecimal characters. Where can I find the channel ID? You can find your channel id on your dashboard, click over the channel name and the ID will be copied on your by editing your channel and getting it from the url.

Example: {"summary":"Channel identificator","value":"a68a72d5abdb040c7b279c707ed5477e"}
Query parameters
daystring · enumOptional

Returns the content of the channel for a given day, if the channel is not a weekly scheduler this param will be ignored. Values available: monday, tuesday, wednesday, thursday, friday, saturday and sunday. The default value is monday.

Example: mondayPossible values:
Responses
200
It will return the content of the channel for a given day, if the channel is not a weekly scheduler it will return the whole content instead.
application/json
ResponsestringExample: The body depends on the format param
404
The channel defined by the id in the path was not found
application/json
get
GET /channel/{channel_id}/schedule HTTP/1.1
Host: deliver.viloud.tv
Accept: */*
The body depends on the format param

Returns the channel EPG (Electronic Program Guide)

get
Path parameters
channel_idstringRequired

Represents the channel id, it is composed by 32 hexadecimal characters. Where can I find the channel ID? You can find your channel id on your dashboard, click over the channel name and the ID will be copied on your by editing your channel and getting it from the url.

Example: {"summary":"Channel identificator","value":"a68a72d5abdb040c7b279c707ed5477e"}
Query parameters
formatstring · enumRequired

Return format for the response, it's required and must be xmltv.

Default: xmltvExample: {"summary":"Return format for the response, it's required and must be xmltv.","value":"xmltv"}Possible values:
days_backwardintegerOptional

Set the backward days to get the content, the default value is 3.

Example: 3
days_forwardintegerOptional

Set the forward days to get the content, the default value is 7.

Example: 7
Responses
200
It will return the content of the channel in XMLTV format.
application/json
Responsestring
404
The channel defined by the id in the path was not found
application/json
get
GET /channel/{channel_id}/epg HTTP/1.1
Host: deliver.viloud.tv
Accept: */*
text
  • Getting channel data
  • GETReturns the channel atributes.
  • GETReturns the channel content
  • GETReturns the channel EPG (Electronic Program Guide)