內容保護（防錄屏）設定

更新時間：2026-01-28 18:57:09

介面描述

1、通过频道号，修改播放器内容保护自定义url跑马灯开关，在开启时需提交url参数
2、接口支持https协议

具體請參考自訂url跑馬燈

介面URL

http://api.polyv.net/live/v2/channelRestrict/{channelId}/set-diyurl-marquee

請求方式

POST

介面約束

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

請求參數描述

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

範例

http://api.polyv.net/live/v2/channelRestrict/2191569/set-diyurl-marquee

表單參數：

appId=frlr1zazn3&sign=58AA674D6BB40AC0BA49A3A7F99C18E8&marqueeRestrict=Y&url=http%3A%2F%2Fdemo.ipolyv.cn%2Fwfy%2Fmarquee.php&timestamp=1621843205017

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或者500的時候，輔助描述錯誤原因
data	String	請求失敗時為空，請求成功時為"設定成功"

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(MarqueeTest.class);

/**
 * 跑马灯设置
 * @throws IOException
 */
@Test
public void testSetMarquee() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2191569";
        String requestUrl = "http://api.polyv.net/live/v2/channelRestrict/"+channelId+"/set-diyurl-marquee";
        String url = "http://demo.ipolyv.cn/wfy/marquee.php";
        String marqueeRestrict = "Y";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("url",url);
        requestMap.put("marqueeRestrict",marqueeRestrict);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(requestUrl, requestMap);
        log.info("测试跑马灯设置接口返回值：{}",response);

}

回應範例

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

成功範例

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": "设置成功"
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}