Batch Delete Channels

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

Interface Description

1、批量删除直播频道
2、如果响应失败，则表示全部频道都失败，不会有部份成功、部份失败的结果
3、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
4、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/basic/batch-delete

Online API Call

Request Method

POST

Interface Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining secret key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and retrieve response data.` See signature generation rules

Request Body Parameter Description

Parameter	Required	Type	Description
channelIds	true	String[]	Request body parameter, list of channel IDs. Maximum of 100 channels can be deleted per request. Must be placed in the request body

Example

http://api.polyv.net/live/v3/channel/basic/batch-delete?appId=frlr1zazn3&sign=73B3F3701C5F80B1002BA598B61DA3E7&timestamp=1621840275897

Request Body Parameters

{
  "channelIds": [
    2306561,
    2306565
  ]
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for 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 true on success, empty string on failure

Java Request Example

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 批量删除频道
 * @throws IOException
 */
@Test
public void testBatchDeleteChannels() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String body = "{\"channelIds\":[2306561,2306565]}";
    String url = "http://api.polyv.net/live/v3/channel/basic/batch-delete";
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, body ,null);
    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": true
}

Error Example

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

Seminar Server API