Aktivierung/Deaktivierung eines SEP-Streams planen

Mit dem JobStartStop Endpunkt können Sie die Aktivierung und Deaktivierung eines vorhandenen Live-SEP planen. Zum angegebenen Zeitpunkt führt unser System die erforderlichen API-Aufrufe durch, um einen Auftrag in Ihrem Namen zu aktivieren und zu deaktivieren.

Voraussetzungen

  • Der Live-API-Schlüssel für Ihr Konto.
  • In Ihrem Live-Konto muss die Planerüberschreibung aktiviert sein.
  • Ein vorhandener Live Job mit "static": true (sehen Statische Einstiegspunktjobs für mehr Informationen).

Erstellen Sie einen Planer

Nehmen wir an, wir möchten eine 2-stündige Veranstaltung planen, die um beginnt 2021-04-02T14:00:00+00:00.

Zeitstempel müssen im UTC-Format als Unix-Zeitstempel in Sekunden formatiert sein. Sie können verwenden https://www.unixtimestamp.com/ zur Konvertierung.

Um den Scheduler zu implementieren, machen Sie Folgendes: POST Anfrage:

https://api.bcovlive.io/v1/scheduler/jobstartstop

Header

Content-Type: application/json
		X-API-KEY: {your API Key}

Anfragetext

{
			"job_id": "your Job ID",
			"activation": {
				"time_utc": 1617386100
			},
			"deactivation": {
				"time_utc": 1617393600
			},
			"description": "My Wednesday broadcast"
		}

Beispielantwort

 
{
	"account_id": "1752604059001",
	"activation": {
		"state": "pending",
		"time_utc": 1617386100
	},
	"deactivation": {
		"state": "pending",
		"time_utc": 1617393600
	},
	"description": "My Wednesday broadcast",
	"job_id": "15981d93877e490185e6ebc9af2c79a3",
	"type": "jobstartstop",
	"workflow_id": "d44cf29f4f184757ac0995beb8a0097e"
}

Aktualisieren Sie einen Planer

Sie können die aktualisieren activation und / oder deactivation Zeit für einen Scheduler, vorausgesetzt, der Job befindet sich in a pending Zustand ("state": "pending"). Senden Sie dazu eine PUT Anfrage zu:

https://api.bcovlive.io/v1/scheduler/jobstartstop/{workflow_id}

Die Header sind die gleichen wie für die POST Anfrage oben gezeigt.

Anfragetext

Fügen Sie in das Anforderungshauptteilobjekt nur das ein activation und / oder deactivation Felder.

Um das Ereignis beispielsweise 30 Minuten früher als geplant zu beenden:

Anfragetext

{
	"deactivation": {
		"time_utc": 1617391800
	}
}

Beispielantwort

 
{
	"account_id": "1752604059001",
	"activation": {
		"state": "pending",
		"time_utc": 1617386100
	},
	"deactivation": {
		"state": "pending",
		"time_utc": 1617391800
	},
	"description": "My Wednesday broadcast",
	"job_id": "15981d93877e490185e6ebc9af2c79a3",
	"type": "jobstartstop",
	"workflow_id": "d44cf29f4f184757ac0995beb8a0097e"
}

Einen Terminplaner stornieren

Sie können die Aktivierung und Deaktivierung mit a abbrechen DELETE Anfrage:

https://api.bcovlive.io/v1/scheduler/jobstartstop/{workflow_id}

Sie können dies auch nach der Aktivierung tun, um die Deaktivierung einfach abzubrechen.

Header

Die einzige erforderliche Kopfzeile ist:

X-API-KEY: your API Key

Anfragetext

Es gibt keinen Anfragetext für diese Anfrage.

Beispielantwort

 
{
		"account_id": "1752604059001",
		"activation": {
			"state": "cancelled",
			"time_utc": 1617386100
		},
		"deactivation": {
			"state": "cancelled",
			"time_utc": 1617391800
		},
		"description": "My Wednesday broadcast",
		"job_id": "15981d93877e490185e6ebc9af2c79a3",
		"type": "jobstartstop",
		"workflow_id": "d44cf29f4f184757ac0995beb8a0097e"
	}

Benachrichtigungen

Beim Erstellen des Workflows können Sie optional Benachrichtigungen konfigurieren. Sie müssen eine URL für unseren Service angeben POST zu. Wir senden eine Benachrichtigung, wenn der Scheduler die Aktivierungs- und Deaktivierungsaufrufe durchführt. Sie können auch konfigurieren, dass eine Benachrichtigung empfangen wird n Sekunden vor der Aktivierung und / oder Deaktivierung. Siehe die Live-Planer-Benachrichtigungen für mehr Details.

Beispielanfragetext

 
{
		"job_id": "your Job ID",
		"activation": {
			"time_utc": 1612274100,
			"notification": 600
		},
		"deactivation": {
			"time_utc": 1612281600,
			"notification": 600
		},
		"description": "My Tuesday broadcast",
		"notification_url": "https://example.com/live/jobstartstop/callbacks"
	}