發布智慧字幕
更新時間:2024-08-27 11:37:46
介面描述
1、当智能字幕生成成功或者校验完成后, 发布字幕应用到视频上,或在点播后台智能字幕模块中使用。详见:[智能字幕](__PLV_KEEP_0__)
2、接口支持https协议
介面URL
http://api.polyv.net/vod/v4/smart-subtitle/publish
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
- URL參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 直播appId。可在「雲點播」->「設定」->「API介面」中查看您的直播appId和appSecret |
| timestamp | true | Long | 當前時間的毫秒級時間戳,30分鐘內有效 |
| sign | true | String | 簽名,32位元大寫MD5值【詳見MD5簽名產生規則】 |
- body參數(json)
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| taskId | true | Long | 字幕任務ID |
| preferenceEnabled | false | String | 字幕發布後,影片是否預設首選目前字幕。Y表示預設首選,字幕發布後對應的影片會優先使用目前字幕,N則相反。若不傳此參數,會讀取目前字幕任務預先設定的值 |
範例
https://api.polyv.net/vod/v4/smart-subtitle/publish?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353
參數:
{
"taskId": 30,
"preferenceEnabled": "Y"
}
響應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 響應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 響應狀態文字資訊 |
| requestId | String | 請求唯一識別碼,如遇介面呼叫失敗情況,可發送此id給客服輔助排查問題 |
| success | boolean | true代表介面呼叫成功,false代表介面呼叫失敗 |
| data | Boolean | 成功返回true, 失敗返回null, 失敗描述資訊請查看error欄位 |
| error | Object | 介面呼叫失敗時的描述資訊,【詳見error欄位說明】 |
error欄位說明
返回錯誤代碼列表
| code | desc | 說明 |
|---|---|---|
| 10002 | 簽名錯誤 | 簽名錯誤,請檢查介面sign參數是否已正常產生 |
| 10003 | 時間戳過期 | 時間戳過期 |
| 20003 | application not found. | appId不存在,請檢查appId是否正確傳值 |
| 56811 | 智慧字幕任務狀態異常 | 僅當字幕任務狀態處於待校驗或待發布狀態時才支援發布 |
響應範例
成功範例
{
"code": 200,
"status": "success",
"requestId": "f813d5d2359743028b6648e54ade1bf1.55.16801596733770029",
"data": true,
"success": true
}
異常範例
時間戳過期
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
簽名錯誤
{
"code": 403,
"status": "error",
"error": {
"code": 10002,
"desc": "签名错误"
},
"success": false
}
字幕任務狀態異常
{
"code": 400,
"status": "error",
"error": {
"code": 56811,
"desc": "智能字幕任务状态异常"
},
"success": false
}
