Programación de la activación / desactivación de una secuencia SEP

Con el JobStartStop endpoint, puede programar la activación y desactivación de un live existente SEP. A la hora especificada, nuestro sistema realizará las llamadas API necesarias para activar y desactivar un trabajo en su nombre.

Requisitos

  • La clave de API en vivo para su cuenta.
  • Su cuenta real debe tener habilitada la anulación del programador.
  • Un trabajo en vivo existente con "static": true (ver Trabajos de punto de entrada estático para más información).

Crea un planificador

Digamos que queremos programar un evento de 2 horas que comenzará a las 2021-04-02T14:00:00+00:00.

Las marcas de tiempo deben estar en UTC formateadas como marca de tiempo Unix en segundos. Puedes usar https://www.unixtimestamp.com/ para la conversión.

Para implementar el planificador, haga lo siguiente POST pedido:

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

Encabezados

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

Cuerpo de la solicitud

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

Respuesta de muestra

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

Actualizar un programador

Puede actualizar el activation y / o deactivation tiempo para un planificador siempre que el trabajo esté en un pending Expresar ("state": "pending"). Para hacer esto, envíe un PUT solicitud de:

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

Los encabezados son los mismos que para el POST solicitud mostrada arriba.

Cuerpo de la solicitud

En el objeto del cuerpo de la solicitud, incluya solo el activation y / o deactivation campos.

Por ejemplo, para detener el evento 30 minutos antes de lo programado:

Cuerpo de la solicitud

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

Respuesta de muestra

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

Cancelar un programador

Puede cancelar la activación y desactivación con un DELETE pedido:

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

También puede hacer esto después de la activación para cancelar la desactivación.

Encabezados

El único encabezado obligatorio es:

X-API-KEY: your API Key

Cuerpo de la solicitud

No hay un cuerpo de solicitud para esta solicitud.

Respuesta de muestra

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

Notificaciones

Opcionalmente, puede configurar notificaciones al crear el flujo de trabajo. Debe proporcionar una URL para que nuestro servicio POST a. Enviaremos una notificación cuando el programador realice las llamadas de activación y desactivación. También puede configurar para recibir una notificación n segundos antes de la activación y / o desactivación. Ver el Notificaciones del programador en vivo para más detalles.

Cuerpo de solicitud de muestra

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