查询多个频道实时并发数据

接口描述

1、获取多个频道实时在线人数
2、接口支持https协议

接口URL

http://api.polyv.net/live/v2/statistics/get-realtime-viewers

在线API调用

请求方式

GET

接口约束

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

2、每个频道返回最近一段时间内(比如:10秒一个点,15条数据,这个时间段可能会做调整,调用接口请不要写死条数。)的实时在线人数信息。每个频道的结果列表按照时间降序排序。

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

channelIds

true

String

多个频道号,用逗号隔开

示例

https://api.polyv.net/live/v2/statistics/get-realtime-viewers?appId=frlr1zazn3&sign=D0B0EF94D4790B08EB6AE800A22497B8&channelIds=1965681%2C2149813&userId=1b448be323&timestamp=1621842353153

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

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

data

Arrray

请求成功时为频道实时在线人数信息【详见Data参数描述】,请求失败时为空

Data参数描述

参数名类型说明

channelId

String

频道号

count

Integer

数字格式,在线人数

time

String

统计的时间,格式:HH:mm:ss

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelViewDataTest.class);
/**
 * 查询多个频道实时并发数据
 * @throws IOException
 */
@Test
public void testGetRealtimeViewers() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v2/statistics/get-realtime-viewers";
    String channelIds = "1965681,2149813";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelIds",channelIds);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询多个频道实时并发数据,返回值:{}",response);
    //do somethings

}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "channelId":1965681,
            "time":"14:15:49",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:15:39",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:15:29",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:15:19",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:15:09",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:14:59",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:14:49",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:14:39",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:14:29",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:14:19",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:14:09",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:13:59",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:13:49",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:13:39",
            "count":0
        },
        {
            "channelId":1965681,
            "time":"14:13:29",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:15:49",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:15:39",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:15:29",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:15:19",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:15:09",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:14:59",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:14:49",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:14:39",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:14:29",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:14:19",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:14:09",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:13:59",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:13:49",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:13:39",
            "count":0
        },
        {
            "channelId":2149813,
            "time":"14:13:29",
            "count":0
        }
    ]
}

异常示例

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

Last updated