查詢打點資訊

更新時間：2025-01-14 15:57:30

介面說明

1、通过视频id获取单个视频的全部打点信息
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口URL中的{vid}为视频id
4、接口支持https协议

介面URL

http://api.polyv.net/v2/video/{userid}/keyframe/{vid}

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

參數名	必填	類型	說明
ptime	true	Long	目前時間的毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
vid	true	String	影片id

範例

http://api.polyv.net/v2/video/1b448be323/keyframe/1b448be323b8d9b9489dcd7e8e09f087_1?vid=1b448be323b8d9b9489dcd7e8e09f087_1&sign=9FD6BA6486D1655C1D1A27C436F835C43BEB8406&ptime=1617174767293

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	請求成功時返回影片打點資訊【詳見data欄位說明】

data參數說明

欄位	類型	說明
duration	String	影片時長，格式為：HH:mm:ss，如：00:02:19
keyframeList	Array	打點資訊列表【詳見keyframeList欄位說明】

keyframeList參數說明

欄位	類型	說明
id	Integer	打點ID
seconds	Integer	打點時間點，單位秒
keyContent	String	打點詳細內容
btnsettingswitch	String	打點按鈕設定開關，不傳表示關閉 Y：為開啟 N：為關閉
btndesc	String	按鈕說明
btnhref	String	按鈕跳轉網址

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodChapterMakerTest.class);
/**
 *查询打点信息
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChapterMaker() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String vid = "1b448be323b8d9b9489dcd7e8e09f087_1";
    
    String url = String.format("http://api.polyv.net/v2/video/%s/keyframe/%s",userId,vid);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.get(url, requestMap);
    log.debug("测试查询打点信息,{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "duration": "00:02:19",
        "keyframeList": [
            {
                "seconds": 10,
                "keyContent": "测试打点10s"
            },
            {
                "seconds": 20,
                "keyContent": "测试打点20s"
            }
        ]
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "the sign is not right.",
    "data": ""
}