建立影片大綱任務
更新時間:2026-09-22 18:27:24
介面說明
1、通过视频id,创建该视频的视频大纲分析任务,分析完成会以http回调的方式把分析结果回调回去,回调地址暂时请您联系保利威客服人员帮您配置
2、接口支持https协议
3、如果视频没有已发布的字幕,会先使用保利威的智能字幕生成字幕。默认自动发布并应用到该视频;传入 autoApplyEnabled="N" 时,字幕正常生成,但不自动发布,状态为“待校验”
4、autoApplyEnabled 仅控制本次新生成字幕的自动发布行为,不会撤下视频已有的字幕。视频已有可用字幕时,直接使用已有字幕生成大纲
介面URL
http://api.polyv.net/vod/v4/video-outline/create
請求方式
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)
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| vid | true | String | 影片id |
| autoApplyEnabled | false | String | 是否在字幕產生後自動發佈並套用到影片。取值為大寫 Y 或 N:Y 表示自動發佈;N 表示不自動發佈,產生後處於「待校驗」狀態。不傳時預設為 Y |
範例
https://api.polyv.net/vod/v4/video-outline/create?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353
參數(產生字幕後不自動發佈):
{
"vid": "833u3s271d15dd452bf8393cfd5d4ac6_8",
"autoApplyEnabled": "N"
}
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| requestId | String | 請求唯一識別碼,如遇介面呼叫失敗情況,可發送此id給客服協助排查問題 |
| success | boolean | true代表介面呼叫成功,false代表介面呼叫失敗 |
| data | Long | 成功返回影片大綱任務id,失敗返回null。 |
| error | Object | 介面呼叫失敗時的描述資訊,【詳見error欄位說明】 |
error欄位說明
返回錯誤代碼列表
| code | desc | 說明 |
|---|---|---|
| 10002 | 簽名錯誤 | 簽名錯誤,請檢查介面sign參數是否已正常產生 |
| 10003 | 時間戳過期 | 時間戳過期 |
| 20003 | application not found. | appId不存在,請檢查appId是否正確傳值 |
回應範例
成功範例
{
"code": 200,
"status": "success",
"requestId": "f813d5d2359743028b6648e54ade1bf1.55.16801596733770029",
"data": 50,
"success": true
}
異常範例
時間戳過期
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
簽名錯誤
{
"code": 403,
"status": "error",
"error": {
"code": 10002,
"desc": "签名错误"
},
"success": false
}
