通知設定

本主題包含有關與通知相關的編碼設置的詳細信息。

概覽

作業或輸出文件完成後，您可以通過多種方式找到有關它的信息。

我們可以發送一個HTTP POST請求詳細信息。
我們可以發送電子郵件。
您可以使用第三方工具（例如恩格羅克。當您在本地進行開發並且Zencoder無法訪問開發服務器時，這很有用。
您可以檢查Zencoder儀表板的作業狀態。
您可以通過Job Show API請求檢查工作狀態。

前兩個-外向HTTP或電子郵件通知-通過在您的Job create API請求中添加通知選項來觸發。

注意事項：

每個輸出和作業的通知限制為5個。輸出通知不計入工作總數。聯繫我們如果您需要更多。
通知負載可能會重複作業通知。您應該按作業ID解析有效負載主體，然後聲明。
當前不支持基於HTTP2構建的服務器上的通知處理程序。傳送至 HTTP2 伺服器的通知可能無法傳遞，而不會傳回任何錯誤。

通知

notifications:Array

API 版本：V2

有效值：通知字符串數組（有效的電子郵件地址或URL）或url和format。

兼容的工作類型：VOD

描述：

指定一個或多個HTTP URL或電子郵件地址，以在作業或輸出完成時通過Webhook進行通知。

對於HTTP通知，通知API請求以以下方式從Zencoder發送到您的服務器：POST到通知URL，並且是包含兩個或三個值的JSON或XML。第一個是作業ID。該ID與您提交初始工作申請時收到的ID相匹配。其次是狀態–“完成”，“失敗”或“已取消”。如果作業包含多個輸出，則此通知還包含您在最初創建作業時提供的輸出標籤。

HTTP通知將發送JSON或XML（取決於請求的format）。

通知內容取決於使用的API版本。

如果在發送通知時Zencoder無法成功連接到目標服務器，則該通知將排隊等待重試。重試時間表包含在通知指南。

授權與安全性

對於經過身份驗證的HTTP通知，請使用以下語法在通知URL中包括用戶名和密碼：https：// username：password@www.example.com/path/to/notification/action

對於HTTPS，只需使用以下命令指定一個URL https://將強制使用SSL安全發送通知。

注意：API V1 僅支援輸出通知，而不支援作業通知。

{
  "input": "s3://zencodertesting/test.mov",
  "notifications": [
    "dev@example.com",
    "http://user:pass@example.com/path/to/notification/action",
    {
      "format": "xml",
      "url": "https://example.com/notifications.html"
    }
  ],
  "outputs": [
    {
      "notifications": [
        "dev@example.com",
        "http://user:pass@example.com/path/to/notification/action",
        {
          "format": "xml",
          "url": "https://example.com/notifications.html"
        }
      ]
    }
  ]
}

也可以看看：url，format和headers

url

url:String

API 版本：V2

上級：notifications

有效值：要通知的有效HTTP或HTTPS URL，可以選擇包括HTTP Auth憑據

兼容的工作類型：VOD

例子：

https://username:password@example.com/notification/path
http://example.com/notification-handler.php

描述：

指向的URL 通知當工作完成時。

使用url指定時的選項notifications作為哈希，包括一個format。如果您不需要指定格式，則只需將URL作為通知數組中的一項包括在內。

對於經過身份驗證的HTTP通知，請使用以下語法在通知URL中包括用戶名和密碼：https：// username：password@www.example.com/path/to/notification/action。

對於HTTPS，只需使用以下命令指定一個URL https://因此將使用SSL安全地發送通知。

通知內容取決於使用的API版本。

如果在發送通知時Zencoder無法成功連接到目標服務器，則該通知將排隊等待重試。嘗試通知最多20次，每次嘗試之間的延遲加倍。

授權與安全性

對於經過身份驗證的HTTP通知，請使用以下語法在通知URL中包括用戶名和密碼：https：// username：password@www.example.com/path/to/notification/action

對於HTTPS，只需使用以下命令指定一個URL https://將強制使用SSL安全發送通知。

注意事項：API V1 僅支援輸出通知，而不支援作業通知。

{
  "input": "s3://zencodertesting/test.mov",
  "notifications": [
    {
      "url": "https://example.com/notifications.html"
    }
  ],
  "outputs": [
    {
      "notifications": [
        {
          "url": "https://example.com/notifications.html"
        }
      ]
    }
  ]
}

也可以看看：notifications，format和headers

格式

format:String

API 版本：V2

上級：notifications

有效值：json要么xml

兼容的工作類型：VOD

例：json

描述：

的格式和內容類型notifications。

默認情況下，HTTP通知使用JSON，HTTP Content-Type為application/json。

對於XML通知，將格式設置為“ xml”。這將返回XML格式的通知，其HTTP Content-Type為application/xml。

注意：除非您指定格式，否則API V1通知不包含HTTP Content-Type。

{
  "input": "s3://zencodertesting/test.mov",
  "notifications": [
    {
      "format": "xml",
      "url": "https://example.com/notifications.html"
    }
  ],
  "outputs": [
    {
      "notifications": [
        {
          "format": "xml",
          "url": "https://example.com/notifications.html"
        }
      ]
    }
  ]
}

也可以看看：notifications，format和headers

標頭

headers:Hash

API 版本：V2

上級：notifications

有效值：鍵必須以字母開頭，並且可以包含字母，數字和-。值可以包含任何字符串。

每個通知標題的長度限制為100個字符。

兼容的工作類型：VOD

例：{'Accept': 'application/json', 'Internal-Id': '12345'}

描述：

默認情況下，HTTP通知與HTTP Content-Type以及User-Agent一起發送。如果您的應用程序需要其他標題，則可以在此處指定它們。

標頭設置為哈希鍵，其值是哈希值。

{
  "input": "s3://zencodertesting/test.mov",
  "notifications": [
    {
      "format": "json",
      "url": "https://example.com/notifications.html",
      "headers": {
        "Accept": "application/json",
        "Internal-Id": "12345"
      }
    }
  ],
  "outputs": [
    {
      "notifications": [
        {
          "format": "json",
          "url": "https://example.com/notifications.html",
          "headers": {
            "Accept": "application/json",
            "Internal-Id": "12345"
          }
        }
      ]
    }
  ]
}

也可以看看：notifications，url和format

事件

event:String

API 版本：V2

上級：notifications

有效值：first_segment_uploaded，seamless_playback

兼容的工作類型：VOD

例：{'event': 'seamless_playback'}

描述：

實時輸出具有與文件進度相對應的其他通知事件。

當實時輸出的第一段已經上傳並且足夠的段已上傳以啟用無縫播放時，可以發送通知。

事件不適用於常規作業和輸出通知，僅適用於實時輸出的通知。

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "live_stream": true,
      "type": "segmented",
      "notifications": [
        {
          "url": "http://zencoderfetcher/notifications.html",
          "event": "seamless_playback"
        }
      ]
    }
  ]
}

也可以看看：notifications，url和format