概述
您可以在以下情況下收到通知 video-change
事件發生在您的視頻庫中。 通知將發送到您指定的URL,該URL應指向能夠處理的應用程序 HTTP POST
請求。
認證
像所有對 CMS API,設置或列出通知訂閱的請求必須使用 訪問令牌。 用於獲取訪問令牌的客戶端憑據必須具有以下權限: video-cloud/notifications/all
(CMS->通知 如果您使用 Studio用戶界面 創建憑據。)
格局
您最多可以指定10個端點來接收通知,方法是: POST
請求 https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions
並在請求主體中包含JSON,如下所示:
{
"endpoint":"http://solutions.brightcove.com/bcls/di-api/di-callbacks.php",
"events":["video-change"]
}
通知以JSON格式發送。 這是一個例子:
{"timestamp":1423840514446,
"account_id":"775205503001",
"event":"video-change",
"video":"4020894387001",
"version":26}
通知欄
項目 | 產品描述 |
---|---|
timestamp |
事件發生的時間 時代 毫秒 |
account_id |
Video Cloud 帳戶ID |
event |
事件的類型-當前這將始終是 video-change |
video |
影片ID |
version |
視頻版本-每組更改事件都會增加視頻版本-例如,創建一組新的移交將構成一組更改事件 |
創建訂閱的請求將收到一個 HTTP 422 在以下情況下的錯誤響應:
-
endpoint
orevents
請求正文中缺少該字段 -
events
字段值不是列表(數組) - 定義的訂閱已存在
- 您已經有10個活動訂閱
通知失敗
通知系統對待任何 4xx
or 5xx
從客戶服務器返回作為可重試失敗。 失敗的回調將最多重試20次,隨後的回調之間的延遲將成倍增加。 前幾次重試將在初始回調嘗試後的幾分鐘內發生。 如果回調繼續失敗,並且我們一直進行到第20次重試,則重試延遲將是幾天。
防火牆
如果您的組織對通過防火牆的傳入流量的來源有嚴格的政策,我們允許使用AWS us-east-1 / Virginia IP。 這可能會更改,因此所有AWS IP都應列入白名單。 看到 http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html 了解更多信息。
通知訂閱的端點
/accounts/{account_id}/subscriptions
創建一個新的訂閱
要創建新的訂閱,請提交 POST
帶有請求主體的請求,包括要通知的端點live紅色到和 video-change
作為單個項目 events
數組:
{ "endpoint": "http://solutions.brightcove.com:9002", "events": [ "video-change" ] }
獲取您的訂閱列表
要獲取所有訂閱的列表,請發送 GET
請求到訂閱端點。
獲取或刪除單個訂閱
使用以下端點來獲取或刪除單個訂閱:
端點
/accounts/{account_id}/subscriptions/{subscription_id}
A GET
請求將檢索訂閱。 一個 DELETE
請求將刪除訂閱。 您目前無法更新訂閱。 如果要修改訂閱,則需要將其刪除並創建一個新的訂閱。
什麼觸發通知?
video-change
視頻元數據的任何更改都會觸發事件。 這包括在Studio或通過 CMS API 寫方法。 還有一些系統事件將觸發 video-change
事件。
將觸發事件的更改包括:
- 視頻已創建
- 開始攝取視頻或資產文件
- 視頻或資產文件的提取已完成
- 新演繹的編碼完成
- 創建海報圖像
- 創建縮略圖
- 視頻已刪除
- 視頻元數據已更改(由系統或用戶更改)
筆記
重新轉碼視頻不會觸發 video-change
事件,除非結果表示形式不同。
刪除視頻後會發生系統事件,因此刪除視頻後,您將收到有關視頻的通知。
什麼會 不 觸發一個 video-change
事件是對視頻資產的更改,不會更改視頻元數據。 例如,如果您替換遠程文本跟踪文件或圖像,但是視頻元數據中記錄的URL保持不變,則不會 video-change
事件將會發生,並且不會發送任何通知。