修改頻道的功能開關狀態
更新時間:2026-06-26 14:52:30
介面描述
1、修改功能开关设置,可修改全局开关设置或频道开关设置
2、接口支持https协议
3、开关类型若未注明默认Y表示开启;isClosePreview当enabled值为Y时,表示的是关闭系统观看页;closeDanmu当enabled值为Y时,表示的是关闭弹幕;closeChaterList当enabled值为Y时,表示的是关闭在线列表
介面URL
http://api.polyv.net/live/v3/channel/switch/update
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | false | String | 頻道號,不傳該參數則表示修改全域設定 |
| type | true | String | 開關類型【取值詳見type欄位說明】 |
| enabled | true | String | 開關值,取值Y/N,具體說明和類型相關【說明詳見type欄位說明】 |
type參數描述
| 參數名 | 說明 |
|---|---|
| isClosePreview | 是否關閉系統觀看頁 Y:表示關閉 N:表示開啟 |
| mobileWatch | 是否開啟行動端系統觀看頁 |
| mobileAudio | 是否開啟行動端音視訊切換 |
| autoPlay | 是否開啟播放器自動播放功能 |
| booking | 是否開啟預約功能 |
| redPack | 是否開啟紅包功能 |
| shareBtnEnabled | 是否開啟分享功能 |
| chat | 是否開啟聊天室 |
| closeChaterList | 是否關閉線上列表 Y:表示關閉 N:表示開啟 |
| consultingMenu | 是否開啟諮詢提問 |
| closeDanmu | 是否關閉彈幕功能 Y:表示關閉 N:表示開啟 |
| barrageSpeed | 彈幕速度 quickest:表示快速 quicker:表示較快 slowest:表示緩慢 slower:表示較慢 standard:表示標準 |
| praise | 是否開啟按讚語功能 |
| welcome | 是否開啟歡迎語功能 |
| viewerSendImgEnabled | 是否開啟觀眾傳送圖片 |
| qaMenuEnabled | 是否開啟問答功能(問答功能未開通则開啟無效) |
| filterManagerMsgEnabled | 過濾聊天室管理員的聊天訊息開關,即觀看頁聊天室只看主持人開關 |
| showCustomMessageEnabled | 顯示自訂訊息開關 |
| chatOnlineNumberEnable | 線上人數開關 |
| pvShowEnabled | 是否顯示「造訪次數」,Y-開啟,N-關閉 |
| recordAutoConvertEnabled | 設定頻道是否自動轉存開關,Y-開啟,N-關閉 |
範例
http://api.polyv.net/live/v3/channel/switch/update
表單參數:
appId=frlr1zazn3&sign=F34B58AA1EE744A5E4D6B64F8554337E&type=autoPlay&enabled=N&channelId=2220949×tamp=1621840863110
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或者500時,輔助描述錯誤原因 |
| data | String | 回應成功時返回true,返回失敗時返回空字串 |
Java請求範例
快速接入基礎代碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
* 修改频道的功能开关状态
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testSwitchUpdate() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "https://api.polyv.net/live/v3/channel/switch/update";
String channelId= String.valueOf(2191569);
String type="mobileWatch";
String enabled="Y";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("type", type);
requestMap.put("enabled", enabled);
requestMap.put("channelId", channelId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.info("测试修改频道的功能开关状态,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":true
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
