End Pseudo-Live Broadcast

Updated: 2023-12-22 11:10:21

Interface Description

1、结束当前正在直播中的伪直播
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/stream/end-disk-push

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
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 not be stored or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID, only supports normal latency pure video channels for setting pseudo-live broadcast
diskVideoId	false	String	Pseudo-live broadcast ID. If not provided, the current ongoing pseudo-live broadcast will be ended.

Example

http://api.polyv.net/live/v3/channel/stream/end-disk-push

Form Parameters:

appId=frlr1zazn3&sign=2A861BD280299A4D7E6FF556C77C88D2&channelId=2149710&timestamp=1621843071824&diskVideoId=1dg53250a3

Response Parameter Description

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 additional error details.
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 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 encapsulation 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
 * @throws NoSuchAlgorithmException
 */
@Test
public void testEndDiskVideo() 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/stream/end-disk-push";
    String channelId = "2149710";
    String diskVideoId = "1dg53250a3";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("diskVideoId", diskVideoId);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试停止伪直播，返回值：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example

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