更新智慧字幕內容

更新時間：2023-06-02 00:25:04

介面描述

1、更新智能字幕生成的字幕内容（需先创建字幕任务）
2、接口支持https协议

介面URL

http://api.polyv.net/vod/v4/smart-subtitle/update

請求方式

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	String	字幕任務id，建立字幕任務時會回傳此id
autoApplyEnabled	false	String	是否在修改完字幕內容後自動發佈該字幕，Y表示自動發佈，N則相反。若不傳此參數，會讀取目前字幕任務預先設定的值
subtitleName	false	String	字幕標題，長度限制20個字元。若不傳此參數，會讀取目前字幕任務預先設定的值
preferenceEnabled	false	String	字幕發佈後，影片是否預設首選目前字幕。Y表示預設首選，字幕發佈後對應的影片會優先使用目前字幕，N則相反。若不傳此參數，會讀取目前字幕任務預先設定的值
subtitles	true	List	【詳見data欄位說明】

字幕內容欄位說明

參數名	類型	說明
start	Long	單條字幕相對影片播放的開始時間，單位為毫秒
end	Long	單條字幕相對影片播放的結束時間，單位為毫秒
content	String	單條字幕的內容

範例

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

參數：

{
    "taskId": 1000,
    "autoApplyEnabled": "Y",
    "subtitleName": "智能字幕",
    "preferenceEnabled": "Y",
    "subtitles": [
        {
            "start": 0,
            "end": 1130,
            "content": "今天，"
        },
        {
            "start": 1210,
            "end": 4340,
            "content": "当我们想在生活中学习一些新知识的时候，"
        },
        {
            "start": 4630,
            "end": 8270,
            "content": "大部分人想到的是去搜索对应的视频教程，"
        },
        {
            "start": 8980,
            "end": 13700,
            "content": "同时越来越多的企业也正在尝试使用视频进行培训。"
        }
    ]
}

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
requestId	String	請求唯一識別碼，如遇介面呼叫失敗情況，可傳送此id給客服輔助排查問題
success	boolean	true代表介面呼叫成功，false代表介面呼叫失敗
data	boolean	true代表介面呼叫成功，false代表介面呼叫失敗
error	Object	介面呼叫失敗時的描述資訊，【詳見error欄位說明】

error欄位說明

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

回傳錯誤代碼列表

code	desc	說明
10002	簽名錯誤	簽名錯誤，請檢查介面sign參數是否已正常產生
10003	時間戳過期	時間戳過期
20003	application not found.	appId不存在，請檢查appId是否正確傳值
56806	檔案上傳失敗	伺服端儲存字幕檔案時失敗
56810	字幕任務不存在或已刪除	字幕任務不存在或已刪除
56811	智慧字幕任務狀態異常	常見於字幕任務尚未初次解析完成，就執行更新字幕操作。或對建立異常的字幕任務執行更新操作

回應範例

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "f813d5d2359743028b6648e54ade1bf1.61.16801654871580495",
    "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",
    "requestId": "f813d5d2359743028b6648e54ade1bf1.58.16801655508460503",
    "error": {
        "code": 56810,
        "desc": "字幕任务不存在或已删除"
    },
    "data": null,
    "success": false
}