Add Schedule Entries by Playlist

Adds a playlist's assets and ad breaks as entries within a live channel's schedule.

By default, a new schedule entry cannot conflict with an existing one. Use the conflict_resolution property to resolve scheduling conflicts.

Request

Request syntax:

POST /channels/Live Channel ID/schedule-playlist

Define the following variable when submitting the above request:

Request body:

Define a schedule entry through the following properties:

Response

The response for a successful request contains the following properties:

items List

The items list describes each schedule entry through the following properties:

source Dictionary

The source dictionary identifies the playlist from which this schedule entry was created.

Sample Request/Response

Call the add_schedule_entries_by_playlist module (Python 3) to create schedule entries from the assets and ad breaks associated with a playlist. This module imports names from the api_auth module.

import json, requests, datetime, time
from api_auth import APICredentials, APIParams
channel_id = 'Hak3zjnPLSW5o0j8GMpzRMsa' # Replace with the ID for the desired live channel.
playlist_id = 'gh35hs89274748j2ab459ne7ud4f6cl3' # Replace with the ID for the desired playlist.

def convert_ts(utc_tstamp):
    """
        Convert a UTC timestamp to ISO 8601 format (YYYY-MM-DDThh:mm:ss.sZ).
        :param utc_tstamp: The UTC timestamp to convert (expected milliseconds)
    """
    iso_format = "%Y-%m-%dT%H:%M:%S.%fZ"
    try:
        _ts = float("{0:.3f}".format(utc_tstamp/1000.0))
        return "{}{}".format(datetime.datetime.utcfromtimestamp(_ts).strftime(iso_format)[:-4], "Z")
    except Exception:
        print ("Invalid timestamp: {}".format(utc_tstamp))
        raise

class ScheduleEntries:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Create mulitple schedule entries.
        """
        self._create_schedule_entries_by_playlist()

    def _create_schedule_entries_by_playlist(self):
        url = "{}{}{}{}".format(self.host, "/api/v4/channels/", channel_id, "/schedule-playlist")

        start = int((time.time() + 3600) * 1000.0) # 1 hour from now
        start = convert_ts(start)

        payload = {
            'playlist_id': playlist_id,
            'start': start
        }

        headers = {'Content-Type': 'application/json'}

        response = requests.post(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

ScheduleEntries().run()

Response:

{
	'@id': '/channels/Hak3zjnPLSW5o0j8GMpzRMsa/schedules?start=now&end=now+240m',
	'@type': 'TimeSeries',
	'start': '2022-12-19T19:48:24.000Z',
	'end': '2022-12-19T23:48:24.000Z',
	'items': [{
			'@id': '/channels/Hak3zjnPLSW5o0j8GMpzRMsa/schedules/631c7c0accbb4bc999ea5536aa81ce91',
			'@type': 'Schedule',
			'id': '631c7c0accbb4bc999ea5536aa81ce91',
			'content_id': '5574ff5e41c04bdd9ed5ed485c6a3211',
			'content_type': 'asset',
			'deleted': '',
			'desc': 'marketing-conference-2022-green-room-morning',
			'dur': 227968,
			'end': '2022-12-19T20:35:30.474Z',
			'external_id': '',
			'owner': '1234567890abcdefghijklmnopqrstu',
			'source': {
				'id': '18495b21df6c410a968f89da32a025ff',
				'type': 'playlist'
			},
			'start': '2022-12-19T20:31:42.506Z',
			'ad_breaks': [],
			'lastmod': '2022-12-19T19:31:43.065Z',
			'created': '2022-12-19T19:31:43.065Z'
		}, {
			'@id': '/channels/Hak3zjnPLSW5o0j8GMpzRMsa/schedules/05a882f291434e788fe09b413a83e8b4',
			'@type': 'Schedule',
			'id': '05a882f291434e788fe09b413a83e8b4',
			'content_id': 'fb19109d3cf6470a806e85307c70842e',
			'content_type': 'asset',
			'deleted': '',
			'desc': 'marketing-conference-2022-red-room-morning',
			'dur': 9856,
			'end': '2022-12-19T20:44:01.217Z',
			'external_id': '',
			'owner': '1234567890abcdefghijklmnopqrstu',
			'source': {
				'id': '18495b21df6c410a968f89da32a025ff',
				'type': 'playlist'
			},
			'start': '2022-12-19T20:43:51.361Z',
			'ad_breaks': [],
			'lastmod': '2022-12-19T19:43:51.709Z',
			'created': '2022-12-19T19:43:51.709Z'
		}, {
			'@id': '/channels/Hak3zjnPLSW5o0j8GMpzRMsa/schedules/2be08e891c544312a984361614b7ae35',
			'@type': 'Schedule',
			'id': '2be08e891c544312a984361614b7ae35',
			'content_id': 'a404b63430a7437a99995d3285a48be6',
			'content_type': 'asset',
			'deleted': '',
			'desc': 'marketing-conference-2022-blue-room-morning',
			'dur': 24493,
			'end': '2022-12-19T20:44:25.710Z',
			'external_id': '',
			'owner': '1234567890abcdefghijklmnopqrstu',
			'source': {
				'id': '18495b21df6c410a968f89da32a025ff',
				'type': 'playlist'
			},
			'start': '2022-12-19T20:44:01.217Z',
			'ad_breaks': [],
			'lastmod': '2022-12-19T19:43:51.709Z',
			'created': '2022-12-19T19:43:51.709Z'
		}
	]
}