Modify Channel Viewer Limit

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

API Description

1、设置频道最大观看在线人数
2、接口URL中的{channelId}为频道号
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channelRestrict/{channelId}/set-max-viewer

<a href="/req.html?api=http://api.polyv.net/live/v2/channelRestrict/{channelId}/set-max-viewer"" target="_blank">Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls are subject to rate limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See: Get Secret Key
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 never be 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
userId	true	String	POLYV user ID, same as on the Polyv official website. Path: Official website -> Login -> Live Streaming (Development Settings)
maxViewer	true	Integer	Maximum concurrent online viewers. Set to 0 to disable the viewer limit.

Example

http://api.polyv.net/live/v2/channelRestrict/2202970/set-max-viewer

Form Parameters:

appId=frlr1zazn3&sign=257EB6F11921A8BDCE2B8210A97F9A7B&userId=1b448be323&timestamp=1621840764246&maxViewer=20

Response Parameters

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See: Global Error Codes
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details.
data	String	Returns "设置成功" on success, empty string on failure.

Java Request Example

For quick integration, download the related dependency source code. Click to download source code. After downloading, add it to your own 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 pools.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 修改频道观看人数限制
 * @throws IOException
 */
@Test
public void testSetMaxViewer() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "2202970";
    String url = String.format("http://api.polyv.net/live/v2/channelRestrict/%s/set-max-viewer",channelId);

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("maxViewer", "20");
    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 global error codes, see Global Error Codes

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "设置成功"
}

Error Example

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