Modify Default Template Settings for Watch Page

API Description

1、修改观看页默认模板设置
2、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Example

http://api.polyv.net/live/v4/user/template/page-setting/update?autoPlayEnabled=N&mobileAudioEnabled=Y&watchFeedbackEnabled=Y&sign=5FB6EEFA7EB92B6D710A9E5889A8F405&barrageSpeed=60&switchPlayerEnabled=Y&pvShowEnabled=Y&showCountdownEnabled=Y&mobileWatchEnabled=Y&viewerVerificationEnabled=N&bookingEnabled=N&mobilePvShowLocation=player&appId=frlr1zazn3&closePreviewEnabled=Y&watchLayout=followTeacher&flashPlayerEnabled=N&barrageEnabled=Y&recordingProtectEnabled=N&forbidFirefoxEnabled=N&watchLangType=follow_browser&timestamp=1686884060082

Response Parameter Description

Error Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 修改观看页默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void pageSettingUpdateTest() 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/page-setting/update";
    String autoPlayEnabled = "N";
    String barrageEnabled = "Y";
    String barrageSpeed = "60";
    String bookingEnabled = "N";
    String closePreviewEnabled = "Y";
    String flashPlayerEnabled = "N";
    String forbidFirefoxEnabled = "N";
    String mobileAudioEnabled = "Y";
    String mobilePvShowLocation = "player";
    String mobileWatchEnabled = "Y";
    String pvShowEnabled = "Y";
    String recordingProtectEnabled = "N";
    String showCountdownEnabled = "Y";
    String switchPlayerEnabled = "Y";
    String viewerVerificationEnabled = "N";
    String watchFeedbackEnabled = "Y";
    String watchLangType = "follow_browser";
    String watchLayout = "followTeacher";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("autoPlayEnabled", autoPlayEnabled);
    requestMap.put("barrageEnabled", barrageEnabled);
    requestMap.put("barrageSpeed", barrageSpeed);
    requestMap.put("bookingEnabled", bookingEnabled);
    requestMap.put("closePreviewEnabled", closePreviewEnabled);
    requestMap.put("flashPlayerEnabled", flashPlayerEnabled);
    requestMap.put("forbidFirefoxEnabled", forbidFirefoxEnabled);
    requestMap.put("mobileAudioEnabled", mobileAudioEnabled);
    requestMap.put("mobilePvShowLocation", mobilePvShowLocation);
    requestMap.put("mobileWatchEnabled", mobileWatchEnabled);
    requestMap.put("pvShowEnabled", pvShowEnabled);
    requestMap.put("recordingProtectEnabled", recordingProtectEnabled);
    requestMap.put("showCountdownEnabled", showCountdownEnabled);
    requestMap.put("switchPlayerEnabled", switchPlayerEnabled);
    requestMap.put("viewerVerificationEnabled", viewerVerificationEnabled);
    requestMap.put("watchFeedbackEnabled", watchFeedbackEnabled);
    requestMap.put("watchLangType", watchLangType);
    requestMap.put("watchLayout", watchLayout);

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

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);

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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "d2a25acab50240e1b344a1c045de36ae.67.16868840687251021",
    "data": null,
    "success": true
}

Error Example

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