Retrieves all publishing schedulesRefers to a configuration that identifies a live channel or live event and a publishing target. Use a publishing schedule to syndicate a live channel or a live event to a social media platform..

Request

Request syntax:

GET /syndication-schedule

Response

The response for a successful request contains the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to the requested endpoint.
@type	String	Returns Collection.
items	List of dictionaries	Contains a list of publishing schedules.
total_items	Integer	Indicates the total number of publishing schedules.

items List

The items list describes each publishing schedule via the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint that returns this publishing schedule.
@type	String	Returns SyndicationSchedule.
audio_track	String	Indicates the name of the audio track that will be published.
content_id	String	Identifies a live channel or live event by its system-defined ID.
content_type	String	Indicates whether the content_id parameter identifies a live channel or a live event. Valid values are: _ e: Live Event _ c: Live Channel
err_msg	String	Indicates the publishing schedule's last error message. The system generates an error message whenever the publishing schedule's status is set to error.
id	String	Indicates the system-defined ID for the publishing schedule.
last_status	String	Indicates the timestamp, in Unix time (milliseconds), at which the publishing schedule's status was last updated.
region	String	Indicates the location where your stream will be converted to a feed that may be ingested by the social media or content distribution platform identified by the publishing target. An empty string identifies the default output location.
region_auto_selected	Boolean	Indicates whether this publishing schedule's publishing location is set to auto selected.
scte35_enabled	Integer	HLS (Push/Pull) or Zixi (Push) Indicates whether SCTE-35 markers will be inserted into the published stream. Valid values are: _ 0: Disabled. _ 1: Enabled.
source_stream Deprecated	String	This parameter has been deprecated.
source_url_params	Dictionary	Contains key-value pairs for query string parameters. Syndication Publishing adds these parameters to the playback URL published to your social media or content distribution platform.
start	Integer	Indicates the timestamp, in Unix time (milliseconds), at which the publishing schedule was last started.
status	String	Indicates the publishing schedule's status. Valid values are: active	stopping	stopped	scheduled	error
stop	Integer	Indicates the timestamp, in Unix time (milliseconds), for either of the following conditions: _ Active Publishing Schedule: Reports one year from the start time. _ Stopped Publishing Schedule: Reports the timestamp at which the publishing schedule entered the stopped state.
syndication_target_description	String	Indicates the description for the publishing target.
syndication_target_id	String	Indicates the system-defined ID for the publishing targetRefers to a configuration that identifies the URL to which your content may be published. A publishing schedule leverages a publishing target configuration to syndicate a live channel or a live event to a social media platform..
target_platform_config	Dictionary	HLS (Push/Pull) or Zixi (Push) Contains a social media or content distribution platform's settings.
type	String	Returns downloader.
url_params_active	Boolean	Indicates whether our service may add your custom query string parameters to the playback URLs defined within the manifest file.
video_quality	String	Indicates the stream quality that will be published to the social media or content distribution platform. Valid values are: high	medium	low

target_platform_config Dictionary

The target_platform_config dictionary describes a social media or content distribution platform's settings via the following properties:

Name	Data Type	Description
broadcast_id	String	Reserved for internal use.
channel_id_pristine	String	Reserved for internal use.
hls_master_url	String	HLS (Pull) Only Indicates the URL to which our service will push a HLS stream once you start publishing to this target. You will need to configure the desired social media or content distribution platform to pull the stream using this URL.
integrated	Boolean	Reserved for future use.
integrated_description	String	Facebook and YouTube (Integrated Authentication) Indicates the video's description.
integrated_title	String	Facebook and YouTube (Integrated Authentication) Indicates the video's title.
integrated_yt_made_for_kids	Boolean	YouTube (Integrated Authentication) Only Indicates whether the video is appropriate for kids.
integrated_yt_privacy	String	YouTube (Integrated Authentication) Only Indicates the video's privacy level. Valid values are: public	private	unlisted
rays	List of string values	HLS (Push/Pull) Contains a list of the ray(s) that will be published. Use the Get Rays endpoint to retrieve a list of rays (all) and their names (ray_name).
stream_id	String	Reserved for internal use.

Sample Request/Response

The code below (Python 3) shows how to retrieve all publishing schedules.

This code imports names from the api_auth module for V4 APIs (see below).

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_publishing_schedule()

    def _get_publishing_schedule(self):
        url = "{}{}".format(self.host, "/api/v4/syndication-schedule")

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

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({}), headers=headers
        )

        print(response.json())

PublishingSchedule().run()

Response:

{
	"@id": "/api/v4/syndication-schedule",
	"@type": "Collection",
	"items": [{
			"@id": "/api/v4/syndication-schedule/e8d6b5cb940c40cc9ec6ad081a38f3f0",
			"@type": "SyndicationSchedule",
			"id": "e8d6b5cb940c40cc9ec6ad081a38f3f0",
			"start": "",
			"stop": "",
			"syndication_target_id": "d30f655670cb426c98cd28afb6291bf4",
			"status": "scheduled",
			"last_status": "",
			"err_msg": "",
			"type": "downloader",
			"video_quality": "medium",
			"audio_track": "en",
			"content_id": "1df8d13992cd4222a7343b8fafd89cd7",
			"content_type": "c",
			"syndication_target_description": "My Publishing Schedule"
		}
	],
	"total_items": 1
}