Batch Modify Channel Danmaku Switch

Updated: 2022-09-02 18:08:07

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be relayed through the customer's own server to call the POLYV server for response data.` See signature generation rules
closeDanmu	true	String	Whether to disable the danmaku feature Y: Disable N: Enable
showDanmuInfoEnabled	true	String	Whether to display danmaku info switch Y: Show N: Hide
channelIds	true	String	Channel IDs for which to modify the danmaku switch. Multiple channel IDs should be separated by commas (,)

Example

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

Form Parameters:

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

Response Parameters

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides auxiliary error description
data	String	Returns an empty string for both success and failure

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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