JobStartStop
エンドポイントでは、既存のライブのアクティブ化と非アクティブ化をスケジュールできます9月。指定された時間に、システムはユーザーに代わってジョブをアクティブ化および非アクティブ化するために必要なAPI呼び出しを行います。要件
- アカウントのLive APIキー。
- ライブアカウントでは、スケジューラのオーバーライドを有効にする必要があります。
- 既存のライブジョブ
「静的」:true
(見る静的エントリポイントジョブ詳細については)。
スケジューラーを作成する
で始まる2時間のイベントをスケジュールしたいとしましょう2021-04-02T14:00:00 + 00:00
。
タイムスタンプは、秒単位のUNIXタイムスタンプとしてUTC形式である必要があります。あなたが使用することができます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"
}
スケジューラーを更新する
あなたは更新することができますアクティベーション
および/または非アクティブ化
ジョブが保留中州 (「状態」:「保留中」
)。これを行うには、置く
リクエスト先:
https://api.bcovlive.io/v1/scheduler/jobstartstop/{workflow_id}
ヘッダーはと同じです役職
上記のリクエスト。
リクエスト本文
リクエスト本文オブジェクトには、アクティベーション
および/または非アクティブ化
田畑。
たとえば、予定より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"
}
スケジューラをキャンセルする
でアクティブ化と非アクティブ化をキャンセルできます消去
リクエスト:
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を提供する必要があります役職
に。スケジューラーがアクティブ化および非アクティブ化の呼び出しを行うと、通知が送信されます。通知を受信するように構成することもできますNS
アクティブ化および/または非アクティブ化の数秒前。を参照してくださいライブスケジューラ通知詳細については。
リクエスト本文の例
{
"job_id": "your Job ID",
"activation": {
"time_utc": 1612274100,
"notification": 600
},
"deactivation": {
"time_utc": 1612281600,
"notification": 600
},
"description": "My Tuesday broadcast",
"notification_url": "http://example.com/live/jobstartstop/callbacks"
}