保利威文档中心

幫助中心

修改預設範本回放設定

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

介面描述

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

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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

2、當請求參數type為single時，origin可設定為record；

3、當請求參數type為list時，origin可以設定為playback或vod；

請求參數描述

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

請求體參數描述

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

範例

http://api.polyv.net/live/v4/user/template/playback-setting/update?appId=frlr1zazn3&sign=9C73C7471CF969AD8AC042221C89551D&timestamp=1677167340447

請求體json參數：

{
    "sectionEnabled": "N",
    "chatPlaybackEnabled": "Y",
    "origin": "vod",
    "type": "list",
    "playbackEnabled": "N",
    "playbackMultiplierEnabled": "Y",
    "playbackProgressBarEnabled": "N",
    "playbackProgressBarOperationType": "drag",
    "showPlayButtonEnabled": "N",
    "productPlaybackEnabled": "Y",
    "questionnairePlaybackEnabled": "Y",
    "qaPlaybackEnabled": "Y",
    "cardPushPlaybackEnabled": "Y",
    "checkInPlaybackEnabled": "Y"
}

回應參數描述

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

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 updatePlaybackSettingTemplateTest() 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/update";
    String chatPlaybackEnabled = "Y";
    String origin = "vod";
    String playbackEnabled = "N";
    String sectionEnabled = "N";
    String type = "list";
    String playbackMultiplierEnabled = "N";
    String playbackProgressBarEnabled = "N";
    String playbackProgressBarOperationType = "drag";
    String showPlayButtonEnabled = "N";
    String productPlaybackEnabled = "Y";
    String questionnairePlaybackEnabled = "Y";
    String qaPlaybackEnabled = "Y";
    String cardPushPlaybackEnabled = "Y";
    String checkInPlaybackEnabled = "Y";

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

    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("chatPlaybackEnabled", chatPlaybackEnabled);
    jsonMap.put("origin", origin);
    jsonMap.put("playbackEnabled", playbackEnabled);
    jsonMap.put("sectionEnabled", sectionEnabled);
    jsonMap.put("type", type);
    jsonMap.put("playbackMultiplierEnabled", playbackMultiplierEnabled);
    jsonMap.put("playbackProgressBarEnabled", playbackProgressBarEnabled);
    jsonMap.put("playbackProgressBarOperationType", playbackProgressBarOperationType);
    jsonMap.put("showPlayButtonEnabled", showPlayButtonEnabled);
    jsonMap.put("productPlaybackEnabled", productPlaybackEnabled);
    jsonMap.put("questionnairePlaybackEnabled", questionnairePlaybackEnabled);
    jsonMap.put("qaPlaybackEnabled", qaPlaybackEnabled);
    jsonMap.put("cardPushPlaybackEnabled", cardPushPlaybackEnabled);
    jsonMap.put("checkInPlaybackEnabled", checkInPlaybackEnabled);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

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

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "a5e9b1d15f544d7a9db6f038156a851d.71.16771673423081591",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服，在线咨询