批量修改频道弹幕开关

接口描述

1、批量修改频道弹幕开关
2、调用后频道会关闭掉通用设置
3、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/basic/batchUpdateDanmu

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
closeDanmu	true	String	是否关闭弹幕功能 Y：表示关闭 N：表示开启
showDanmuInfoEnabled	true	String	是否显示弹幕信息开关， Y：表示显示 N：表示不显示
channelIds	true	String	需要修改弹幕开关的频道号，多个频道号用半角逗号 , 隔开

示例

http://api.polyv.net/live/v3/channel/basic/batchUpdateDanmu

表单参数：

closeDanmu=Y&showDanmuInfoEnabled=N&appId=xxxxx&sign=46D2EA10829A84BDF52DAF2ABA0C5507&channelIds=2191541,2191542&timestamp=1621840828944

响应参数描述

参数名	类型	说明
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(ChannelOperateTest.class);
/**
 * 修改直播推流方式
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testBatchUpdateDanmu() 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/basic/batchUpdateDanmu";
    String channelIds = "2191541,2191542";
    String closeDanmu = "Y";
    String showDanmuInfoEnabled = "N";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("closeDanmu", closeDanmu);
    requestMap.put("showDanmuInfoEnabled", showDanmuInfoEnabled);
    requestMap.put("channelIds", channelIds);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("批量修改频道弹幕开关，返回值：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "success"
}

异常示例

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