查詢智慧字幕內容
更新時間:2023-06-02 00:15:31
介面描述
1、通过字幕任务id,查询视频字幕的链接和字幕内容(需先创建字幕任务)
2、接口支持https协议
介面URL
http://api.polyv.net/vod/v4/smart-subtitle/get
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
- URL參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 直播appId。可在「雲點播」->「設定」->「API介面」中查看您的直播appId和appSecret |
| timestamp | true | Long | 目前時間的毫秒級時間戳記,30分鐘內有效 |
| taskId | true | Long | 字幕任務id,建立字幕任務時會回傳此id |
| sign | true | String | 簽名,32位元大寫MD5值【詳見MD5簽名產生規則】 |
範例
https://api.polyv.net/vod/v4/smart-subtitle/get
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功回傳,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| requestId | String | 請求唯一識別碼,如遇介面呼叫失敗情況,可將此id提供給客服協助排查問題 |
| success | boolean | true代表介面呼叫成功,false代表介面呼叫失敗 |
| data | Object | 成功時回傳字幕資料【詳見data欄位說明】 |
| error | Object | 介面呼叫失敗時的描述資訊,【詳見error欄位說明】 |
data欄位說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| taskId | Long | 字幕任務id |
| link | String | 字幕連結 |
| autoApplyEnabled | String | 是否在字幕產生後自動套用字幕到對應的影片上,Y表示自動套用字幕,N表示不自動套用字幕 |
| subtitleName | String | 字幕標題 |
| preferenceEnabled | String | 是否為預設首選的影片字幕,Y代表預設首選,N則相反 |
| subtitles | List | 字幕內容, 【詳見字幕內容欄位說明】 |
字幕內容欄位說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| start | Long | 單條字幕相對影片播放的開始時間,單位為毫秒 |
| end | Long | 單條字幕相對影片播放的結束時間,單位為毫秒 |
| content | String | 單條字幕的內容 |
error欄位說明
回傳錯誤代碼列表
| code | desc | 說明 |
|---|---|---|
| 10002 | 簽名錯誤 | 簽名錯誤,請檢查介面sign參數是否已正常產生 |
| 10003 | 時間戳過期 | 時間戳過期 |
| 20003 | application not found. | appId不存在,請檢查appId是否正確傳值 |
| 56810 | 字幕任務不存在或已刪除 | 字幕任務不存在或者字幕任務已經被刪除 |
| 56812 | 字幕正在產生中,請稍後再試 | 解析影片的字幕任務未完成 |
回應範例
成功範例
{
"code": 200,
"status": "success",
"requestId": "f813d5d2359743028b6648e54ade1bf1.60.16801640807450383",
"data": {
"taskId": 1120,
"link": "https://img.videocc.net/usrt/8/833584471d/srt/55016df7-2381-41b7-b594-bf3e5f058561.srt",
"autoApplyEnabled": "N",
"subtitleName": "智能字幕",
"preferenceEnabled": "Y",
"subtitles": [
{
"start": 0,
"end": 1130,
"content": "今天,"
},
{
"start": 1210,
"end": 4340,
"content": "当我们想在生活中学习一些新知识的时候,"
},
{
"start": 4630,
"end": 8270,
"content": "大部分人想到的是去搜索对应的视频教程,"
},
{
"start": 8980,
"end": 13700,
"content": "同时越来越多的企业也正在尝试使用视频进行培训。"
}
]
},
"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",
"requestId": "f813d5d2359743028b6648e54ade1bf1.53.16801641320540391",
"error": {
"code": 56810,
"desc": "字幕任务不存在或已删除"
},
"data": null,
"success": false
}
