# 修改频道的功能开关状态 ### 接口描述 ``` 1、修改功能开关设置，可修改全局开关设置或频道开关设置 2、接口支持https协议 3、开关类型若未注明默认Y表示开启；isClosePreview当enabled值为Y时，表示的是关闭系统观看页；closeDanmu当enabled值为Y时，表示的是关闭弹幕；closeChaterList当enabled值为Y时，表示的是关闭在线列表 ``` ### 接口URL ``` http://api.polyv.net/live/v3/channel/switch/update ``` [在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/switch/update/README.md) ### 请求方式 ``` POST ``` ### 接口约束 1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md) ### 请求参数描述 | 参数名 | 必选 | 类型 | 说明 | | --------- | ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appId | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】 | | timestamp | true | Long | 当前13位毫秒级时间戳，3分钟内有效 | | sign | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 | | channelId | false | String | 频道号，不传该参数则表示修改全局设置 | | type | true | String | 开关类型【取值详见[type字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/account/switch_update.md?id=polyv1)】 | | enabled | true | String | 开关值，取值Y/N，具体说明和类型相关【说明详见[type字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/account/switch_update.md?id=polyv1)】 | **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 | 在线人数开关 | ### 示例 ```requestUrl http://api.polyv.net/live/v3/channel/switch/update ``` 表单参数： ```requestUrl appId=frlr1zazn3&sign=F34B58AA1EE744A5E4D6B64F8554337E&type=autoPlay&enabled=N&channelId=2220949×tamp=1621840863110 ``` ### 响应参数描述 | 参数名 | 类型 | 说明 | | ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- | | code | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】 | | status | String | 响应状态文本信息 | | message | String | 响应描述信息，当code为400或者500的时候，辅助描述错误原因 | | data | String | 响应成功时返回true，返回失败时返回空字符串 | ### Java请求示例 快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。 > 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。 ```java 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 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 } ``` ### 响应示例 系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md) 成功示例 ```json { "code":200, "status":"success", "message":"", "data":true } ``` 异常示例 ```json { "code": 400, "status": "error", "message": "invalid signature.", "data": "" } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://polyv.gitbook.io/document/docs/live/api/account/switch_update.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.