Modify Channel Status to Prohibit Live Streaming

Updated: 2025-09-04 14:01:16

Interface Description

1、禁止频道的直播推流，禁止有效期为24小时，24小时后会恢复频道推流
2、接口URL中的{channelId}为频道号
3、接口支持https协议

Interface URL

http://api.polyv.net/live/v2/stream/{channelId}/cutoff

Online API Call

Request Method

POST

Interface Constraints

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

Request Parameter Description

Parameter Name	Required	Type	Description
appId	true	String	Account appId [See details in Get 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 to the POLYV server for response data.` [See details in Signature Generation Rules]
userId	true	String	POLYV user ID, consistent with the one on the Polyv official website. Path: Official website -> Login -> Live Streaming (Development Settings)
forbidTime	false	Long	13-digit timestamp of the ban end date. Maximum ban duration is 90 days. If not provided, the default ban duration is 24 hours.
playbackForbidden	false	String	Whether to prohibit playback on the viewing page after stream interruption. Supported values: Y and N. Default is N, meaning not prohibited.

Example

http://api.polyv.net/live/v2/stream/1958888/cutoff

Form Parameters:

appId=frlr1zazn3&sign=77605E1C4002B98E5FCB74236A77E295&userId=1b448be323&timestamp=1621841101196

Response Parameter Description

Parameter Name	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. [See details in Global Error Description]
status	String	Response status text information
message	String	Response description message. 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 code project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained 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 testLiveBanPush() 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/stream/%s/cutoff";
    String channelId = "2095812";
    
    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 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": ""
}