智慧字幕回呼通知說明
更新時間:2024-12-16 19:20:19
功能說明
在智慧字幕相關處理環節(如建立成功、處理中、待驗證、待發布、發布成功等)觸發後,系統會將此時智慧字幕任務的狀態,透過HTTP方式回呼給客戶的服務,以便了解字幕任務處理進度。
其他說明
- 對回呼介面回應HTTP狀態碼200,視為本次回呼成功,後續不會發起回呼重試。
- 對回呼介面回應的HTTP狀態碼非200,視為本次回呼失敗,後續會發起回呼重試,但最多只會重試3次,三次重試仍失敗後將不會再觸發當前事件的回呼。
- 需要特別注意,回呼的HTTP請求到達使用者的伺服器時,有可能是亂序的。例如某個影片,使用者可能會先收到字幕處理中的回呼,然後才收到字幕任務建立成功回呼,這是由於網路原因無法保證請求到達伺服器的順序,保利威側不會等前一個回呼事件請求收到200回應後再發起下一個事件回呼。
回呼配置
登入雲點播管理後台,在 設定 --> 回呼設定 配置智慧字幕回呼URL。

有配置了智慧字幕回呼URL的使用者,預設都會發送回呼請求。
回呼事件類型
一、智慧字幕任務建立成功
- 事件描述:點播服務端接收完建立字幕任務後,會觸發智慧字幕任務建立成功事件。
- HTTP請求方式為:POST。
- HTTP請求參數格式:application/json
回呼參數
| 名稱 | 類型 | 必填 | 描述 |
|---|---|---|---|
| sign | string | 是 | 詳見(字幕回呼簽名參數) |
| timestamp | long | 是 | 當前事件觸發時的時間,格式是13位時間戳 |
| callbackType | string | 是 | 回呼類型,固定值 create_success |
| taskId | long | 是 | 字幕任務ID |
| vid | string | 是 | 影片ID |
回呼範例
https://demo.ipolyv.cn/subtitle-task/callback/test
{
"sign": "02EAD645ED22A87B35A9818BDE24A884125267C7",
"timestamp": 1683622364265,
"callbackType": "create_success",
"taskId": 1777787830,
"vid": "858584471d00e18997cdfe3hyx31adde_8",
}
二、智慧字幕任務處理中
- 事件描述:開始處理影片產生字幕的任務,包括提取影片音訊、音訊辨識為文字等操作。
- HTTP請求方式為:POST。
- HTTP請求參數格式:application/json
回呼參數
| 名稱 | 類型 | 必填 | 描述 |
|---|---|---|---|
| sign | string | 是 | 詳見(字幕回呼簽名參數) |
| timestamp | long | 是 | 當前事件觸發時的時間,格式是13位時間戳 |
| callbackType | string | 是 | 回呼類型,固定值 processing |
| taskId | long | 是 | 字幕任務ID |
| vid | string | 是 | 影片ID |
回呼範例
https://demo.ipolyv.cn/subtitle-task/callback/test
{
"sign": "02EAD645ED22A87B35A9818BDE24A884125267C7",
"timestamp": 1683622364265,
"callbackType": "processing",
"taskId": 1777787830,
"vid": "858584471d00e18997cdfe3hyx31adde_8",
}
三、智慧字幕任務處理失敗
- 事件描述:在處理影片產生字幕的過程中,某個操作步驟失敗會觸發此回呼。
- HTTP請求方式為:POST。
- HTTP請求參數格式:application/json
回呼參數
| 名稱 | 類型 | 必填 | 描述 |
|---|---|---|---|
| sign | string | 是 | 詳見(字幕回呼簽名參數) |
| timestamp | long | 是 | 當前事件觸發時的時間,格式是13位時間戳 |
| callbackType | string | 是 | 回呼類型,固定值 process_fail |
| taskId | long | 是 | 字幕任務ID |
| vid | string | 是 | 影片ID |
回呼範例
https://demo.ipolyv.cn/subtitle-task/callback/test
{
"sign": "02EAD645ED22A87B35A9818BDE24A884125267C7",
"timestamp": 1683622364265,
"callbackType": "process_fail",
"taskId": 1777787830,
"vid": "858584471d00e18997cdfe3hyx31adde_8",
}
四、智慧字幕任務待驗證
- 事件描述:收到此回呼說明影片字幕已經產生完畢,可以在保利威點播後台智慧字幕功能模組中對該影片自動產生的字幕做驗證。
- HTTP請求方式為:POST。
- HTTP請求參數格式:application/json
回呼參數
| 名稱 | 類型 | 必填 | 描述 |
|---|---|---|---|
| sign | string | 是 | 詳見(字幕回呼簽名參數) |
| timestamp | long | 是 | 當前事件觸發時的時間,格式是13位時間戳 |
| callbackType | string | 是 | 回呼類型,固定值 waiting_for_review |
| taskId | long | 是 | 字幕任務ID |
| vid | string | 是 | 影片ID |
| link | string | 是 | 字幕檔案位址 |
回呼範例
https://demo.ipolyv.cn/subtitle-task/callback/test
{
"sign": "02EAD645ED22A87B35A9818BDE24A884125267C7",
"timestamp": 1683622364265,
"callbackType": "waiting_for_review",
"taskId": 1777787830,
"vid": "858584471d00e18997cdfe3hyx31adde_8",
"link": "https://img.videocc.net/usrt/8/833584471d/srt/03735b72-24a7-44c1-b751-24aabbf8903c.srt"
}
五、智慧字幕任務待發布
- 事件描述:智慧字幕驗證完成後觸發此回呼,代表可以執行發布字幕操作,把字幕套用到對應的影片上。
- HTTP請求方式為:POST。
- HTTP請求參數格式:application/json
回呼參數
| 名稱 | 類型 | 必填 | 描述 |
|---|---|---|---|
| sign | string | 是 | 詳見(字幕回呼簽名參數) |
| timestamp | long | 是 | 當前事件觸發時的時間,格式是13位時間戳 |
| callbackType | string | 是 | 回呼類型,固定值 waiting_for_publish |
| taskId | long | 是 | 字幕任務ID |
| vid | string | 是 | 影片ID |
| link | string | 是 | 字幕檔案位址 |
回呼範例
https://demo.ipolyv.cn/subtitle-task/callback/test
{
"sign": "02EAD645ED22A87B35A9818BDE24A884125267C7",
"timestamp": 1683622364265,
"callbackType": "waiting_for_publish",
"taskId": 1777787830,
"vid": "858584471d00e18997cdfe3hyx31adde_8",
"link": "https://img.videocc.net/usrt/8/833584471d/srt/03735b72-24a7-44c1-b751-24aabbf8903c.srt"
}
六、智慧字幕發布成功
- 事件描述:收到此回呼,代表字幕已成功套用到對應的影片上,但仍需等待一段時間(一般是10分鐘左右,等快取過期後)播放影片時就可以選擇到最新發布的字幕了。
- HTTP請求方式為:POST。
- HTTP請求參數格式:application/json
回呼參數
| 名稱 | 類型 | 必填 | 描述 |
|---|---|---|---|
| sign | string | 是 | 詳見(字幕回呼簽名參數) |
| timestamp | long | 是 | 當前事件觸發時的時間,格式是13位時間戳 |
| callbackType | string | 是 | 回呼類型,固定值 publish_success |
| taskId | long | 是 | 字幕任務ID |
| vid | string | 是 | 影片ID |
| link | string | 是 | 字幕檔案位址 |
回呼範例
https://demo.ipolyv.cn/subtitle-task/callback/test
{
"sign": "02EAD645ED22A87B35A9818BDE24A884125267C7",
"timestamp": 1683622364265,
"callbackType": "publish_success",
"taskId": 1777787830,
"vid": "858584471d00e18997cdfe3hyx31adde_8",
"link": "https://img.videocc.net/usrt/8/833584471d/srt/03735b72-24a7-44c1-b751-24aabbf8903c.srt"
}
字幕回呼簽名參數說明
驗證簽名(sign)參數可以有效避免收到偽造的回呼請求,請對接了字幕回呼的使用者務必驗證簽名參數是否正確,以免造成不必要的麻煩。
簽名產生規則
- 對字串 (secretKey + timestamp + timestamp + secretKey) 做SHA1加密。例如SHA1(mySecretKey16836223642651683622364265mySecretKey)
- 把SHA1加密後的字串轉成大寫
其中timestamp是13位時間戳,會在回呼介面的請求參數中取得,使用者的secretKey可以在 設定 --> API介面中查看。

