建立智慧字幕任務

更新時間：2024-09-03 16:44:09

介面說明

1、通过视频id，创建该视频的字幕任务，自动为该视频生成一份字幕文件，字幕文件可通过接口查询，或在点播后台智能字幕模块中使用。详见：[智能字幕](__PLV_KEEP_0__)
2、接口支持https协议

介面URL

http://api.polyv.net/vod/v4/smart-subtitle/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或者不傳該參數代表不自動套用字幕
language	false	String	如果不傳或者傳了不支援的語言會預設當成chinese(中文)處理【詳見language欄位說明】
repetitionEnabled	false	String	是否允許重複任務，Y-允許，N-不允許，預設Y

language欄位說明

參數值	語言
chinese	中文
chinese_english_cantonese	中英粵
chinese_medical	中文醫療
cantonese	粵語
english	英語
japanese	日語
korean	韓語
vietnamese	越南
malay	馬來語
indonesian	印尼
filipino	菲律賓語
thai	泰文
portuguese	葡萄牙語
turkish	土耳其
arabic	阿拉伯語
spanish	西班牙語
spanish	西班牙語

範例

https://api.polyv.net/vod/v4/smart-subtitle/create?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353

參數：

{
    "vid": "833u3s271d15dd452bf8393cfd5d4ac6_8",
    "language": "chinese",
    "autoApplyEnabled": "Y"
}

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
requestId	String	請求唯一識別碼，如遇介面呼叫失敗情況，可提供此id給客服輔助排查問題
success	boolean	true代表介面呼叫成功，false代表介面呼叫失敗
data	Long	成功回傳字幕任務id，失敗回傳null。待字幕產生後可根據此字幕任務id查詢字幕檔案連結和字幕資料
error	Object	介面呼叫失敗時的描述資訊，【詳見error欄位說明】

error欄位說明

參數名	類型	說明
code	Integer	錯誤碼【詳見回傳錯誤代碼列表】
desc	String	錯誤描述【詳見回傳錯誤代碼列表】

回傳錯誤代碼列表

code	desc	說明
10002	簽名錯誤	簽名錯誤，請檢查介面sign參數是否已正常產生
10003	時間戳過期	時間戳過期
20003	application not found.	appId不存在，請檢查appId是否正確傳值
56800	非法VID	影片不存在；影片狀態不正確（非已發布狀態）；影片時長超過5小時
56809	資源或餘額不足	資源或餘額不足，請充值後再使用

回應範例

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "f813d5d2359743028b6648e54ade1bf1.55.16801596733770029",
    "data": 1000,
    "success": true
}

異常範例

時間戳過期

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}

簽名錯誤

{
    "code": 403,
    "status": "error",
    "error": {
        "code": 10002,
        "desc": "签名错误"
    },
    "success": false
}