計劃 SEP 流的激活/停用

隨著JobStartStop端點，您可以安排現有活動的激活和停用九月 .在指定的時間，我們的系統將進行必要的 API 調用，以代表您激活和取消激活作業。

需求

  • 您帳戶的實時 API 密鑰。
  • 您的真實賬戶必須啟用調度程序覆蓋。
  • 現有的實時工作"static": true（看靜態入口點作業了解更多信息）。

創建調度程序

假設我們要安排一個 2 小時的活動，該活動將於2021-04-02T14:00:00+00:00 .

時間戳必須採用 UTC 格式，格式為以秒為單位的 unix 時間戳。您可以使用 https://www.unixtimestamp.com/ 進行轉換。

要實施調度程序，請執行以下操作POST要求：

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

標頭

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

要求主體

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

範例回應

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

更新調度程序

您可以更新activation和/或deactivation調度程序的時間，前提是作業處於pending狀態 （"state": "pending" ).為此，請發送一個PUT請求：

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

標頭與POST請求如上所示。

要求主體

在請求正文對像中，僅包含activation和/或deactivation領域。

例如，要比預定時間提前 30 分鐘停止活動：

要求主體

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

範例回應

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

取消調度程序

您可以使用取消激活和停用DELETE要求：

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

您也可以在激活後執行此操作以取消停用。

標頭

唯一需要的標題是：

X-API-KEY: your API Key

要求主體

此請求沒有請求正文。

範例回應

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

通知

您可以選擇在創建工作流時配置通知。您需要為我們的服務提供一個 URL POST到。當調度程序進行激活和停用調用時，我們將發送通知。您還可以配置為接收通知n激活和/或停用前幾秒。有關詳細信息，請參閱 實時調度程序通知 。

請求主體範例

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