Planification de l'activation/désactivation d'un flux SEP

Le JobStartStop terminal vous permet de planifier l'activation et la désactivation d'un SEP actif existant. Au moment spécifié, notre système effectuera les appels API nécessaires pour activer et désactiver un travail en votre nom.

Exigences

  • La clé API Live pour votre compte.
  • Le remplacement du planificateur doit être activé sur votre compte réel.
  • Un travail en direct existant avec "static": true (voir Tâches de point d'entrée statique pour plus d'informations).

Créer un planificateur

Disons que nous voulons planifier un événement de 2 heures qui commencera à 2021-04-02T14:00:00+00:00.

Les horodatages doivent être au format UTC au format Unix en secondes. Vous pouvez utiliser https://www.unixtimestamp.com/ pour reconversion.

Pour implémenter le planificateur, effectuez la POST demande suivante :

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

Headers

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

Corps de la demande

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

Exemple de réponse

 
{
	"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"
}

Mettre à jour un planificateur

Vous pouvez mettre à jour le activation et / ou deactivation heure pour un planificateur à condition que le travail soit dans un pending Etat ("state": "pending"). Pour ce faire, envoyez une PUT demande à :

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

Les en-têtes sont les mêmes que pour le POST demande illustrée ci-dessus.

Corps de la demande

Dans l'objet du corps de la requête, incluez uniquement le activation et / ou deactivation des champs.

Par exemple, pour arrêter l'événement 30 minutes plus tôt que prévu :

Corps de la demande

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

Exemple de réponse

 
{
	"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"
}

Annuler un planificateur

Vous pouvez annuler l'activation et la désactivation en faisant la DELETE demande suivante :

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

Vous pouvez également le faire après l'activation pour simplement annuler la désactivation.

Headers

Le seul en-tête requis est :

X-API-KEY: your API Key

Corps de la demande

Il n'y a pas de corps de requête pour cette requête.

Exemple de réponse

 
{
		"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"
	}

Notifications

Vous pouvez éventuellement configurer des notifications lors de la création du workflow. Vous devez fournir une URL pour que notre service POST à. Nous enverrons une notification lorsque le planificateur effectuera les appels d'activation et de désactivation. Vous pouvez également configurer pour recevoir une notification n secondes avant l'activation et / ou la désactivation. Voir le Notifications du programmateur en direct pour plus de détails.

Exemple de corps de requête

 
{
		"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"
	}