查询频道实时并发数据

接口描述

1、在直播中,查询频道实时在线人数
2、接口URL中的{channelId}为频道号
3、接口支持https协议

接口URL

http://api.polyv.net/live/v1/statistics/{channelId}/realtime

在线API调用

请求方式

GET

接口约束

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

2、每个频道返回最近2分半钟(10秒一个点,15条数据)的实时在线人数信息。每个频道的结果列表按照时间降序排序

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

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

userId

true

String

直播账号ID

示例

http://api.polyv.net/live/v1/statistics/1965681/realtime?appId=frlr1zazn3&sign=CA1500965A0589D8DC65713B33F63B2D&userId=1b448be323&timestamp=1621842236528

响应参数描述

参数名类型说明

status

String

状态值

result

Array

相应的结果【详见Result参数描述

Result参数描述

参数名类型说明

time

String

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

count

String

某个时间,实时观看人数

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 testRealtime() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v1/statistics/%s/realtime","1965681");

    //http 调用逻辑
    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.get(url, requestMap);
    log.info("测试查询频道实时并发数据,返回值:{}",response);
    //do somethings

}

响应示例

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

成功示例

{
    "status":"success",
    "result":[
        {
            "count":"0",
            "time":"09:55:50"
        },
        {
            "count":"0",
            "time":"09:55:40"
        },
        {
            "count":"0",
            "time":"09:55:30"
        },
        {
            "count":"0",
            "time":"09:55:20"
        },
        {
            "count":"0",
            "time":"09:55:10"
        },
        {
            "count":"0",
            "time":"09:55:00"
        },
        {
            "count":"0",
            "time":"09:54:50"
        },
        {
            "count":"0",
            "time":"09:54:40"
        },
        {
            "count":"0",
            "time":"09:54:30"
        },
        {
            "count":"0",
            "time":"09:54:20"
        },
        {
            "count":"0",
            "time":"09:54:10"
        },
        {
            "count":"0",
            "time":"09:54:00"
        },
        {
            "count":"0",
            "time":"09:53:50"
        },
        {
            "count":"0",
            "time":"09:53:40"
        },
        {
            "count":"0",
            "time":"09:53:30"
        }
    ]
}

异常示例

{
    "code":"invalid.request",
    "msg":"signature error."
}

Last updated