修改频道观看人数限制

接口描述

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

接口URL

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

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名

必选

类型

说明

appId

true

String

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

userId

true

String

POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）

maxViewer

true

Integer

最大观看在线人数，等于0时表示关闭在线人数观看限制

示例

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

表单参数：

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

响应参数描述

参数名

类型

说明

code

Integer

status

String

响应状态文本信息

message

String

响应描述信息，当code为400或者500的时候，辅助描述错误原因

data

String

请求成功时为设置成功，请求失败为空字符串

Java请求示例

快速接入基础代码请下载相关依赖源码，点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

异常示例

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

Previous设置子频道单点登录token Next设置频道单点登录token

Last updated 4 months ago

Was this helpful?

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 }