Modify Channel Status to No Live Stream

Updated: 2023-10-20 14:18:08

Interface Description

1、修改频道直播状态为无直播
2、接口URL中的{channelId}为频道号
3、接口支持https协议
4、该接口的状态修改不会触发直播状态改变回调。

Interface URL

http://api.polyv.net/live/v2/channels/{channelId}/end

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 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 called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
userId	true	String	POLYV user ID, consistent with the one on the Polyv official website. Retrieval path: Official website -> Login -> Live Streaming (Development Settings)

Example

http://api.polyv.net/live/v2/channels/1958888/end

Form Parameters:

appId=frlr1zazn3&sign=71B236A8BAB0A921248FEE91A082EA2B&userId=1b448be323&timestamp=1621841075595

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates successful return, non-200 indicates failure. See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides auxiliary error reason description
data	String	Returns "success" on successful request, 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 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 functionality 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(ChannelStateTest.class);
/**
 * 设置频道为无直播状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetStatusEnd() 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/v2/channels/%s/end";
    String channelId = "2149813";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("userId", userId);
    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": ""
}