取得暫存影片大綱

更新時間：2025-12-26 09:01:17

介面說明

根據頻道 ID 與暫存檔案 ID 查詢 AI 大綱與答題內容（若已產生）
介面支援 HTTPS 協定

介面 URL

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/get-by-fileId

線上 API 呼叫

請求方式

GET

介面限制

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

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號 appId【詳見取得金鑰】
timestamp	true	Long	目前 13 位毫秒級時間戳記，3 分鐘內有效
sign	true	String	簽名，為 32 位大寫的 MD5 值。`產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有 API 都必須透過客戶自己伺服器中轉呼叫 POLYV 伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	Integer	頻道 ID
fileId	true	String	暫存檔案 ID

範例

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/get-by-fileId?appId=frlr1zazn3&sign=79767F7E02132E1904C304E4F225CC2A&timestamp=1634783281943&channelId=100001&fileId=recordFileId123

回應參數說明

參數名	類型	說明
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 參數說明

參數名	類型	說明
status	String	大綱產生狀態：init-初始化，srt_processing-字幕產生中，outline_processing-大綱產生中，audit-待審核，success-完成，fail-產生失敗
outline	Object	大綱 JSON，未產生或產生失敗時為空
question	Object	答題 JSON，未產生或產生失敗時為空
failReason	String	失敗原因（status=fail 時回傳）

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 getRecordFileOutlineTest() 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/get-by-fileId";
    String channelId = "100001";
    String fileId = "recordFileId123";

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

    String response = HttpUtil.get(url, requestMap);
    log.info("测试获取暂存视频大纲成功：{}", response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "b38bdd97dc404213a2436e7a086b9db9.82.16347832877195279",
    "data": {
        "status": "success",
        "outline": {
            "title": "直播回放大纲",
            "items": [
                {
                    "title": "开场介绍",
                    "startTime": 0,
                    "endTime": 120
                }
            ]
        },
        "question": [
            {
                "question": "本场主题是什么？",
                "answer": "产品发布",
                "startTime": 60
            }
        ]
    },
    "success": true
}

異常範例

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