チャンネルコールバックの使用

Prev Next

Classic/VPC環境で利用できます。

VOD Stationは、チャンネル状態確認のためにコールバック(Callback)機能を使用します。コールバックを使用すると、VOD Stationでチャンネル状態変更イベントが発生するたびに設定されたnotificationUrlにコールバックメッセージが自動的に送信されます。次の APIでリクエストする際は、notificationUrlにコールバック URLを入力してコールバックを設定してください。

コールバックメッセージ

コールバックメッセージの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|--- |--- |--- |--- |
| id | String | - | チャンネル ID |
| name | String | - | チャンネル名 |
| channelStatus | String | - | チャンネルの状態

  • READY | STARTING | STOPPING | STOPPED | FORCE_STOPPING | FORCE_STOPPED | TERMINATING | TERMINATED | FORCE_TERMINATING | FORCE_TERMINATED
    • READY: 運用中
    • STARTING: 開始中
    • STOPPING: 停止中
    • STOPPED: 停止完了
    • TERMINATING: 削除中
    • TERMINATED: 削除完了
    • FORCE_STOPPING: 強制停止中
    • FORCE_STOPPED: 強制停止完了
    • FORCE_TERMINATING: 強制削除中
    • FORCE_TERMINATED: 強制削除完了
|

コールバックメッセージの例

コールバックメッセージのサンプルコードは次の通りです。

// チャンネル運用中(READY)
{
  "id": "vs-20260414133728-*******",
  "name": “ch-callback”,
  "channelStatus": "READY"
}

// チャンネル停止(STOPPED)
{
  "id": "vs-20260414133728-*******",
  "name": "ch-callback",
  "channelStatus": "STOPPED"
}

// チャンネル削除(TERMINATED)
{
  "id": "vs-20260414133728-*******",
  "name": "ch-callback",
  "channelStatus": "TERMINATED"
}