建立暫存影片大綱

更新時間：2026-01-16 08:58:18

介面說明

用於建立暫存影片的 AI 大綱任務
可選開啟知識測驗、審核後發布與回放自動打點
介面支援 HTTPS 協定

介面URL

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/create

線上API呼叫

請求方式

POST

介面限制

介面同時支援 HTTP、HTTPS，建議使用 HTTPS 確保介面安全
介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值。`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
fileId	true	String	暫存檔案ID
aiKnowledgeQuizEnabled	false	String	知識測驗開關，Y：開啟，N：關閉，預設 N
aiSummaryAuditEnabled	false	String	大綱審核後發布開關，Y：開啟，N：關閉，預設 N
syncToPlaybackDotEnabled	false	String	回放自動打點開關，Y：開啟，N：關閉，預設 N

範例

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/create?appId=frlr1zazn3&sign=79767F7E02132E1904C304E4F225CC2A&timestamp=1634783281943

請求body範例

{
    "fileId": "recordFileId123",
    "aiKnowledgeQuizEnabled": "Y",
    "aiSummaryAuditEnabled": "N",
    "syncToPlaybackDotEnabled": "N"
}

回應參數說明

參數名	類型	說明
code	Integer	狀態碼，與 http 狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求產生的唯一 UUID，僅可用於排查、除錯，不應該和業務掛鉤
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
data	Object	【詳見Data欄位說明】

Error參數說明

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

Data參數說明

請求成功時回傳空物件

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼：點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的 HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 创建暂存视频大纲
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createRecordFileOutlineTest() throws IOException, NoSuchAlgorithmException {
    //公共参数，填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/create";
    String fileId = "recordFileId123";

    //请求body参数
    Map<String, Object> requestBody = new HashMap<>();
    requestBody.put("fileId", fileId);
    requestBody.put("aiKnowledgeQuizEnabled", "Y");
    requestBody.put("aiSummaryAuditEnabled", "N");
    requestBody.put("syncToPlaybackDotEnabled", "N");

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.postJson(url, requestMap, JsonUtil.toJson(requestBody));
    log.info("测试创建暂存视频大纲成功：{}", response);
    //do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "b38bdd97dc404213a2436e7a086b9db9.82.16347832877195279",
    "data": {},
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360832149273615",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}