Channel API (Deprecated)

The Channel API allows for the listing and setting of channel lineups.

Note: This software is deprecated. Use the latest version.

There are three modes, 'list', 'assign' and 'create'. As in the Query API, interaction with the Channel API is through signed REST-style requests to http://api.ooyala.com/partner/channels.

Required Parameters

  • pcode – Provider Code
  • expires – Query expiration time in seconds since epoch (00:00:00 1/1/1970 GMT)
  • mode – One of list, assign, create
  • channelEmbedCode – Embed code of the channel being acted upon.
  • signature – The digital signature of the request. The signature should be calculated using SHA-256 with the signature generation rules.

List Mode

List all channel components. No additional parameters required.

Example:

http://www.ooyala.com/partner/channels?pcode=<pcode>&channelEmbedCode=<channelEmbedCode>
&expires=<expiration>&mode=list&signature=<signature>

Result:

<?xml version="1.0" encoding="UTF-8"?>
<channel>
  <embedCode>9scDM426LtgO5kElm3ddWAExjw6uq7Rs</embedCode>
  <title>New Channel</title>
  <status>live</status>
  <item>
    <embedCode>w4adOyOiMjsW-58yCgrY92IOer3v_hAp</embedCode>
    <title>demo.mp4</title>
    <description></description>
    <status>live</status>
    <content_type>Video</content_type>
    <uploadedAt>1217036203</uploadedAt>
    <length>130766</length>
    <size>23641511</size>
    <updatedAt>1234765782</updatedAt>
  </item>
</channel>

Assign Mode

Additional required parameter: embedCodes

Assigns a comma-separated list of video embed codes (or a single embed code) to a channel embed code as a lineup. Embed codes for other channels or channel sets are invalid. An existing channel lineup will be overwritten when using this mode. Returns a text file with 'OK' on success or an error message on failure.

Example:

http://www.ooyala.com/partner/channels?pcode=<pcode>&channelEmbedCode=<channelEmbedCode>&embedCodes=<embedCode1>,<embedCode2>&expires=<expiration>&mode=assign&signature=<signature>

Create Mode

Additional required parameter: title

Create a channel in Backlot with the given title.

Example:

http://www.ooyala.com/partner/channels?pcode=<pcode>&expires=<expiration>&mode=create&title=<channelTitle>&signature=<signature>

Result:

<?xml version="1.0" encoding="UTF-8"?>
<channel>
  <embedCode>R2NTZkMTpJ0i-YaH8cPuKwS_yHJgri7O</embedCode>
  <title>My Channel Title</title>
  <status>live</status>
</channel>

Was this article helpful?