プラットフォーム Callback
Kollus Live は、ライブ配信の開始/終了、録画ファイル転送などの主要イベント発生時に、お客様が事前に指定した URL へ通知(Callback)を送信します。 これにより、外部システムとのリアルタイム同期および作業の自動化を実現できます。
プラットフォーム Callback の種類
- Live Callback: ライブ配信ステータスの確認
- 録画ファイル転送 Callback: 生成された録画ファイルの転送結果の確認
Callback 設定方法
Callback URL はチャンネルごとに独立して設定できます。
- Kollus Live コンソール > [チャンネル管理] > [チャンネルリスト]に移動します。
- 状況に応じて、次のいずれかを選択します。
- 新規チャンネル作成時に設定: 右上の[チャンネル登録]をクリックします。
- 既存チャンネルに設定: 対象チャンネル右側の[修正]をクリックします。
- 下部の[Callback] タブで、目的に合った Callback URL を入力し、[保存する]をクリックします。
Callback フロー
通信規格
転送方式
- Method:
POST - Content-Type:
application/x-www-form-urlencoded - 送信タイミング: イベント発生時に即時送信
応答条件
- 成功応答: HTTP Status Code 200 を返す(レスポンスボディは無視されます)
- 失敗判定: 200 以外のステータスコードを返す、または Timeout が発生した場合(リトライキューに登録されます)
Timeout 制限
| 区分 | 制限時間 | 説明 |
|---|---|---|
| Connect Timeout | 2 秒 | サーバー接続試行の制限時間 |
| Response Timeout | 3 秒 | リクエスト送信後の応答待ち制限時間 |
リトライ
リトライポリシー
一時的なネットワーク障害やお客様サーバーの遅延により送信に失敗した場合、システムは自動的にリトライを実行します。
- リトライ間隔: 5 分間隔
- 最大回数: 3 回(初回送信を含む合計 4 回試行)
- ログ確認: すべての送信およびリトライ結果はログに記録されます。
⚠️ Callback 重複受信の防止
ネットワーク遅延により、お客様サーバーが正常処理後に応答を送信したにもかかわらず、Kollus システムが Timeout として認識し、Callback を再送信する場合があります。
- 推奨事項: お客様のシステムは、同一イベントを重複受信した場合でもデータの整合性に問題が生じないよう、重複処理防止ロジックを必ず実装してください。
リクエストパラメーター
各イベントごとに送信されるパラメーターの仕様です。
参考文書
キー (Key) 情報については、認証と主要キードキュメントを参照してください。
Live Callback
ライブ配信ステー タスが変更された際に送信される情報です。
| パラメーター | タイプ | 説明 |
|---|---|---|
version | string | Callback バージョン |
service_account_key | string | サービスアカウントキー |
channel_key | string | チャンネルキー |
stream_key | string | ストリームキー |
broadcast_key | string | ライブ配信キー |
broadcast_state | string | ライブ配信ステータス
|
録画ファイル転送 Callback
録画ファイル転送機能を使用する場合、ファイル転送結果の情報を含みます。
| パラメーター | タイプ | 説明 |
|---|---|---|
version | string | Callback バージョン |
service_account_key | string | サービスアカウントキー |
channel_key | string | チャンネルキー |
stream_key | string | ストリームキー |
broadcast_key | string | ライブ配信キー |
recording_file_id | integer | 録画ファイルの一意識別子 |
recording_file_filename | string | 録画ファイル名 |
recording_file_kind | string | 録画方式
|
recording_file_transfer_result | integer | ファイル転送結果
|