查詢預設範本回放設定

更新時間：2026-03-05 17:25:45

介面描述

1、查询回放默认模板设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/template/playback-setting/get

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/live/v4/user/template/playback-setting/get?appId=frlr1zazn3&sign=82ADECF49C78E5F6399D99A6EDE4EEAD&timestamp=1677167039930

回應參數描述

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

Data參數描述

參數名	類型	說明
playbackEnabled	String	回放開關 Y：開啟 N：關閉
type	String	觀看頁回放方式 single：單一影片 list：列表回放
origin	String	回放影片來源 record：暫存 playback：回放列表 vod：點播列表
sectionEnabled	String	章節開關 Y：開啟 N：關閉
chatPlaybackEnabled	String	聊天回放開關 Y：開啟 N：關閉
playbackMultiplierEnabled	String	倍數播放開關 Y：開啟 N：關閉
playbackProgressBarEnabled	String	進度條開關 Y：開啟 N：關閉
playbackProgressBarOperationType	String	進度條操作方式 drag 拖曳，prohibitDrag 禁止拖曳，dragHistoryOnly 只能拖曳已觀看內容
showPlayButtonEnabled	String	顯示播放按鈕開關 Y：開啟 N：關閉
chatPlaybackEnabled	String	聊天互動重現開關 Y：開啟 N：關閉
productPlaybackEnabled	String	商品庫互動重現開關 Y：開啟 N：關閉
questionnairePlaybackEnabled	String	問卷互動重現開關 Y：開啟 N：關閉
qaPlaybackEnabled	String	答題卡互動重現開關 Y：開啟 N：關閉
cardPushPlaybackEnabled	String	卡片推送互動重現開關 Y：開啟 N：關閉
checkInPlaybackEnabled	String	簽到互動重現開關 Y：開啟 N：關閉

Error參數描述

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

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 getPlaybackSettingTest() 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/user/template/playback-setting/get";

    //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.get(url, requestMap);

    log.info("测试查询回放默认模板设置成功：{}", response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "62420aef40254ac2b8b13a9a0895d285.75.16771670417921429",
    "data": {
        "playbackEnabled": "Y",
        "sectionEnabled": "N",
        "type": "single",
        "origin": "record",
        "chatPlaybackEnabled": "Y",
        "playbackMultiplierEnabled": "Y",
        "playbackProgressBarEnabled": "N",
        "playbackProgressBarOperationType": "drag",
        "showPlayButtonEnabled": "N",
        "chatPlaybackEnabled": "Y",
        "productPlaybackEnabled": "Y",
        "questionnairePlaybackEnabled": "Y",
        "qaPlaybackEnabled": "Y",
        "cardPushPlaybackEnabled": "Y",
        "checkInPlaybackEnabled": "Y"
    },
    "success": true
}

異常範例

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