Skip to navigation
CLOUD PLAYOUT APISchedule channel

Add several events to a schedule channel

This endpoint places up to 500 events on a Cloud Playout schedule channel in one request, so a block of programming from a few minutes to a full day can be scheduled in a single call rather than one event at a time.

The request is all or nothing. Every event is checked before any is written, and if any event cannot be placed, none of them are and the response lists every event that was a problem, identified by its position in the array as events[0], events[1] and so on.

How it works

  1. Make a POST request to this endpoint with an events array. Each entry has a type and a startTime.

  2. What else an entry carries depends on its type:

    • vod plays one media item. Send its referenceId and leave endTime and name out; the event ends when the media does.
    • live reserves a slot for the channel’s live input. Send endTime and a name, and leave referenceId out. The slot must be at least 5 minutes long.

  3. The response returns the events that were created, in the order they play.

All of the events must fall within a single 24 hour window, measured from the earliest start to the latest end, and every one must sit inside the channel’s own start and end times. Events may not overlap one another or anything already scheduled on the channel; an event may start exactly when the previous one ends. Media used by a vod event must have reached the ready status. On a channel that is on air, no event may start or end in the next few minutes.

Gaps between events are allowed. The channel shows its slate for any time nothing is scheduled.

Example

A news channel loads tomorrow’s line-up in one request: an overnight loop of recorded bulletins as vod events, a two hour live slot for the morning show, and the afternoon programming, all placed at their exact times.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the schedule channel the events are added to.

Request

This endpoint expects an object.
eventslist of objectsRequired
The events to place on the channel. Up to 500 per request, and all of them must fall within a single 24 hour window.

Response

Events added to the schedule channel successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
datalist of objectsOptional
The events on the channel, in the order they play.