修改預設範本內容保護(防錄屏)設定
更新時間:2026-01-28 18:56:22
介面描述
1、更新内容保护默认模板设置
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/user/template/marquee/update
請求方式
POST
介面限制
1、介面同時支援HTTP及HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| timestamp | true | String | 目前13位毫秒級時間戳記,3分鐘內有效 |
請求體參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| enable | true | String | 內容保護開關 Y:開啟 N:關閉 |
| antiRecordType | false | String | 內容保護方式,內容保護開關開啟時必填 marquee:跑馬燈 watermark:浮水印 |
| modelType | false | String | 內容保護類型,內容保護開關開啟時必填,浮水印方式時設定自訂URL無效 fixed:固定 nickname:使用者名稱 diyurl:url自訂設定,僅跑馬燈方式有效 |
| content | false | String | 內容保護類型是固定值時為設定內容 URL自訂設定時為網址,需攜帶 http:// 或 https:// 內容保護類型為登入使用者名稱時可不傳,固定值和url自訂設定時必傳 |
| opacity | false | Integer | 跑馬燈透明度,範圍0-99 浮水印透明度,範圍0-100 |
| fontSize | false | String | 字型大小 內容保護方式為跑馬燈時:設定數值,範圍1-256 內容保護方式為浮水印時: small:小 middle:中 large:大 |
| fontColor | false | String | 跑馬燈字型顏色,色值,例如:#FFFFFF |
| showMode | false | String | 跑馬燈顯示方式 roll:滾動 flicker:閃爍 |
| doubleEnabled | false | String | 雙跑馬燈開關 Y:開啟 N:關閉 |
| autoZoomEnabled | false | String | 自訂縮放開關 Y:開啟 N:關閉 |
範例
http://api.polyv.net/live/v4/user/template/marquee/update?appId=frlr1zazn3&sign=EC5A0EF79FAE452F1393A33B10AD6173×tamp=1677201932605
請求體json參數:
{
"doubleEnabled": "N",
"autoZoomEnabled": "Y",
"enable": "Y",
"fontSize": "20",
"showMode": "flicker",
"modelType": "fixed",
"opacity": "80",
"content": "测试跑马灯内容test",
"fontColor": "#ff4d4f",
"antiRecordType": "marquee"
}
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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 updateMarqueeTemplateTest() 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/marquee/update";
String antiRecordType = "marquee";
String autoZoomEnabled = "Y";
String content = "测试跑马灯内容test";
String doubleEnabled = "N";
String enable = "Y";
String fontColor = "#ff4d4f";
String fontSize = "20";
String modelType = "fixed";
String opacity = "80";
String showMode = "flicker";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("antiRecordType", antiRecordType);
jsonMap.put("autoZoomEnabled", autoZoomEnabled);
jsonMap.put("content", content);
jsonMap.put("doubleEnabled", doubleEnabled);
jsonMap.put("enable", enable);
jsonMap.put("fontColor", fontColor);
jsonMap.put("fontSize", fontSize);
jsonMap.put("modelType", modelType);
jsonMap.put("opacity", opacity);
jsonMap.put("showMode", showMode);
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.67.16772019328880111",
"data": null,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
