查詢頻道內容保護（防錄屏資訊）

更新時間：2026-01-28 18:46:53

介面描述

1、通过频道号，查询频道内容保护（防录屏信息）
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/anti/record/get

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/live/v3/channel/anti/record/get?appId=frlr1zazn3&sign=879C66B1CF3AB6C8536294E33D492C53&channelId=2453970&timestamp=1629968257454

回應參數描述

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

data欄位描述

參數名	類型	說明
antiRecordType	String	內容保護方式 marquee：跑馬燈 watermark：浮水印
modelType	String	內容保護類型 fixed：固定值 nickname：登入使用者名稱 diyurl：URL自訂設定
content	String	固定值時為設定內容 URL自訂設定時為網址
opacity	Integer	透明度
fontSize	String	字型大小內容保護方式為跑馬燈時，設定數值，範圍1-256 內容保護方式為浮水印時 small：小 middle：中 large：大
fontColor	String	跑馬燈字型顏色，色值，浮水印時不返回此參數
autoZoomEnabled	String	跑馬燈自訂縮放，浮水印時不返回此參數 Y：開啟 N：關閉
doubleEnabled	String	雙跑馬燈，浮水印時不返回此參數 Y：開啟 N：關閉
showMode	String	跑馬燈顯示方式，浮水印時不返回此參數 roll：滾動 flicker：閃爍

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(MarqueeTest.class);
/**
 * 查询频道内容保护
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void marqueeGetTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/anti/record/get";
    String channelId = "2453970";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道内容保护：{}", response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "antiRecordType": "marquee",
        "modelType": "fixed",
        "content": "test",
        "opacity": 80,
        "fontSize": "20",
        "fontColor": "#FFF",
        "autoZoomEnabled": "Y",
        "doubleEnabled": "N",
        "showMode": "flicker"
    }
}

異常範例

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