查询多个频道的实时在线人数

接口URL

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

接口说明

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

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
channelIds string 多个频道ID,用逗号隔开
sign string 签名,32位大写MD5值

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
{
"channelId": 140972,
"time": "10:58:53",
"count": 4
},
{
"channelId": 140972,
"time": "10:58:45",
"count": 4
},
{
"channelId": 140972,
"time": "10:58:37",
"count": 4
},
{
"channelId": 140972,
"time": "10:58:29",
"count": 4
}
    ]
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

签名错误

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

未输入channelIds

{
    "code": 400,
    "status": "error",
    "message": "channelIds is required.",
    "data": ""
}

输入channelIds里包含有非数字的频道ID

{
    "code": 400,
    "status": "error",
    "message": "channelId must be int",
    "data": ""
}

输入channelIds不存在

{
    "code": 400,
    "status": "error",
    "message": "channelId not exist",
    "data": ""
}

输入了非法的channelIds

{
    "code": 403,
    "status": "error",
    "message": "invalid channelId.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 放回的结果集
channelId 频道ID
account 数字格式,在线人数
time 统计的时间,格式:HH:mm:ss

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

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelIds = "108888,10002";

$params = array(
    'appId'=>$appId,
    'channelIds'=>$channelIds,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.polyv.net/live/v2/statistics/get-realtime-viewers?appId=$appId&timestamp=$timestamp&channelIds=$channelIds&sign=$sign";

//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

分页查询频道观看日志

接口URL

http://api.polyv.net/live/v2/statistics/{channelId}/viewlog

接口说明

1、作用:分页获取频道的观看日志
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
page string 页数
pageSize string 每页显示的数据条数,默认每页显示1000条数据
currentDay string 查询日期,格式:yyyy-MM-dd
param1 string 观看用户ID
sign string 签名,32位大写MD5值

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": {
        "pageNumber": 1, 
        "totalItems": 3, 
        "contents": [
{
"playId": "1520501687122X1438160",
"userId": "1c6dc3c666",
"channelId": 151462,
"playDuration": 341,
"stayDuration": 361,
"flowSize": 10028116,
"sessionId": "eyz0awxrlh",
"param1": "1520499775580",
"param2": "广州观众/78614",
"param3": "live",
"param4": "",
"param5": "",
"ipAddress": "59.42.41.1",
"country": "中国",
"province": "广东",
"city": "广州",
"isp": "/南沙区电信",
"referer": "https://live.polyv.cn/watch/151462",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
"operatingSystem": "Mac OS X",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2018-03-08",
"createdTime": 1520501705000,
"lastModified": 1520504494000
}, 
{
"playId": "1520501157256X1429802",
"userId": "1c6dc3c666",
"channelId": 151462,
"playDuration": 29,
"stayDuration": 528,
"flowSize": 1068201,
"sessionId": "eyz0awxrlh",
"param1": "1520499775580",
"param2": "广州观众/78614",
"param3": "live",
"param4": "",
"param5": "",
"ipAddress": "59.42.41.1",
"country": "中国",
"province": "广东",
"city": "广州",
"isp": "/南沙区电信",
"referer": "https://live.polyv.cn/watch/151462",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
"operatingSystem": "Mac OS X",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2018-03-08",
"createdTime": 1520501664000,
"lastModified": 1520504494000
}, 
            {
"playId": "1520500551108X1714565",
"userId": "1c6dc3c666",
"channelId": 151462,
"playDuration": 18,
"stayDuration": 20,
"flowSize": 3048444,
"sessionId": "eyz0awxrlh",
"param1": "1520499775580",
"param2": "广州观众/78614",
"param3": "live",
"param4": "",
"param5": "",
"ipAddress": "59.42.40.205",
"country": "中国",
"province": "广东",
"city": "广州",
"isp": "/南沙区电信",
"referer": "https://live.polyv.cn/watch/151462",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
"operatingSystem": "Mac OS X",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2018-03-08",
"createdTime": 1520500572000,
"lastModified": 1520503294000
}
        ], 
        "endRow": 3, 
        "startRow": 1, 
        "firstPage": true, 
        "lastPage": true, 
        "nextPageNumber": 1, 
        "prePageNumber": 1, 
        "totalPages": 1, 
        "limit": 3, 
        "offset": 0
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

签名错误

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

未输入currentDay

{
    "code": 400,
    "status": "error",
    "message": "currentDay is empty.",
    "data": ""
}

频道不存在

{
    "code": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

非法的频道ID

{
    "code": 403,
    "status": "error",
    "message": "invalid channelId.",
    "data": ""
}

字段说明

参数名 说明
code 响应的状态码,例如:200
status 响应状态
message 异常错误信息
data 响应结果集
pageNumber 当前的页数
totalItems 总的条数
contents 查询的结果列表
playId 表示此次播放动作的ID
userId 用户ID
channelId 频道号
playDuration 播放时长
stayDuration 缓存时长
flowSize 流量大小
sessionId 用户自定义参数,如学员ID等
param1/2/3/4/5 POLYV系统参数
ipAddress IP地址
country 国家
province 省份
city 城市
isp ISP运营商
referer 播放视频页面地址
userAgent 用户设备
operatingSystem 操作系统
browser 浏览器
isMobile 是否为移动端
currentDay 日志查询日期 (格式为:yyyy-MM-dd)
createdTime 日志创建日期 (13位时间戳)
lastModified 日志更新日期 (13位时间戳)
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一个视频在回放视频中的位置
endRow 当前页最后一个视频在回放视频中的位置
limit 当前页视频个数

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelId = "124545";
$currentDay = "2018-03-12";  
$page = "1"; //页数
$pageSize="10";//每页显示的数据

$params = array(
    'appId'=>$appId,
    'currentDay'=>$currentDay,
    'page'=>$page,
    'pageSize'=>$pageSize,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.polyv.net/live/v2/statistics/$channelId/viewlog?appId=$appId&currentDay=$currentDay&page=$page&pageSize=$pageSize&timestamp=$timestamp&sign=$sign";

//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

查询多个频道汇总的统计数据

接口URL

http://api.polyv.net/live/v2/statistics/{userId}/channel_summary

接口说明

1、根据是否提交channelIds来获取全部频道/某个频道的播放数据
2、接口URL中的{userId}为直播账号ID
3、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
startDate string 查询的开始日期 格式为yyyy-MM-dd
endDate string 查询的结束日期 格式为yyyy-MM-dd
channelIds string 要查询的频道号,不提交默认为查询所有频道,多个频道号以英文逗号“,”分开,如:105420,104400

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "userId": null,
            "channelId": 101385,
            "name": "测试频道号12",
            "pcPlayDuration": 3738,
            "pcFlowSize": 14585121564,
            "pcVideoView": 944,
            "pcUniqueViewer": 138,
            "mobilePlayDuration": 399,
            "mobileFlowSize": 7937281,
            "mobileVideoView": 195,
            "mobileUniqueViewer": 71
        },
        {
            "userId": null,
            "channelId": 103669,
            "name": "直播回看1",
            "pcPlayDuration": 2943,
            "pcFlowSize": 3069092519,
            "pcVideoView": 1009,
            "pcUniqueViewer": 101,
            "mobilePlayDuration": 305,
            "mobileFlowSize": 0,
            "mobileVideoView": 104,
            "mobileUniqueViewer": 63
        }
    ]
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

签名错误

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

日期格式不正确

{
    "code": 400,
    "status": "error",
    "message": "日期格式要求为yyyy-MM-dd.",
    "data": ""
}

channelIds格式错误

{
    "code": 400,
    "status": "error",
    "message": "channelIds is wrong.",
    "data": ""
}

channelds的频道号不属于当前账号

{
    "code": 400,
    "status": "error",
    "message": "channelIds is mismatching.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
channelId 频道Id
name 频道名称
pcPlayDuration pc端播放时长,单位:分钟
pcFlowSize pc端播放流量,单位为Byte
pcVideoView pc视频播放量
pcUniqueViewer pc端唯一观众数
mobilePlayDuration 移动端播放时长,单位:分钟
mobileFlowSize 移动端播放流量,单位为Byte
mobileVideoView 移动端播放量
mobileUniqueViewer 移动端唯一观众数

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$startDate = "2017-09-11";
$endDate = "2018-03-08";
$channelIds = "127075,127074,127071";

$params = array(
    'appId'=>$appId,
    'startDate'=>$startDate,
    'endDate'=>$endDate,
    'channelIds'=>$channelIds,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.polyv.net/live/v2/statistics/".$userId."/channel_summary?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign."&endDate=".$endDate."&startDate=".$startDate."&channelIds=".$channelIds;
//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

查询频道某段时间内的统计数据

接口URL

http://api.polyv.net/live/v2/statistics/{channelId}/summary

接口说明

1、作用:通过频道ID获取该频道某段时间的直播统计数据。
2、接口URL中的{channelId}为 频道ID
3、接口支持https协议

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
startDay yyyy-MM-dd的日期字符串 要查询的数据的开始日期
endDay yyyy-MM-dd的日期字符串 要查询的数据的结束日期
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值

响应成功JSON示例:

{
    status: "success",
    result: [
    {
        currentDay: "2017-08-02",
        channelId: 101378,
        userId: "edv3kno3t5",
        pcPlayDuration: 18,
        pcFlowSize: 7533133,
        pcVideoView: 3,
        pcUniqueViewer: 1,
        mobilePlayDuration: 10,
        mobileFlowSize: 0,
        mobileVideoView: 6,
        mobileUniqueViewer: 2,
        createdTime: 1501697384000,
        lastModified: 1501697384000
    }, {
        currentDay: "2017-08-03",
        channelId: 101378,
        userId: "edv3kno3t5",
        pcPlayDuration: 34,
        pcFlowSize: 23014636,
        pcVideoView: 10,
        pcUniqueViewer: 1,
        mobilePlayDuration: 16,
        mobileFlowSize: 0,
        mobileVideoView: 5,
        mobileUniqueViewer: 2,
        createdTime: 1501783204000,
        lastModified: 1501783204000
    }, {
        currentDay: "2017-08-04",
        channelId: 101378,
        userId: "edv3kno3t5",
        pcPlayDuration: 3,
        pcFlowSize: 0,
        pcVideoView: 1,
        pcUniqueViewer: 1,
        mobilePlayDuration: 0,
        mobileFlowSize: 0,
        mobileVideoView: 0,
        mobileUniqueViewer: 0,
        createdTime: 1501816874000,
        lastModified: 1501816874000
    }
]}

响应失败JSON示例:

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

字段说明

参数名 说明
currentDay 当期日期:yyyy-MM-dd
channelId 频道ID
userId 直播账号ID
pcPlayDuration PC端播放时长,单位:分钟
pcFlowSize PC端消耗流量,单位:bytes
pcVideoView PC端总播放量,类似PV
pcUniqueViewer PC端唯一观众数,类似UV
mobilePlayDuration 移动端播放时长,单位:分钟
mobileFlowSize 移动端消耗流量,单位:bytes
mobileVideoView 移动端总播放量,类似PV
mobileUniqueViewer 移动端唯一观众数,类似UV
createdTime 记录添加的时间
lastModified 记录修改的时间

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelId = "127075";
$startDay = "2017-09-11";
$endDay = "2018-03-08";

$params = array(
    'appId'=>$appId,
    'endDay'=>$endDay,
    'startDay'=>$startDay,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.live.polyv.net/v2/statistics/".$channelId."/summary?timestamp=".$timestamp."&sign=".$sign."&endDay=".$endDay."&startDay=".$startDay."&appId=".$appId;
//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取频道观看日志

接口URL

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

接口说明

1、获取观看日志
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

 GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
currentDay string 查询日期,格式:yyyy-MM-dd
param1 string 观看用户ID
userId string 直播账号ID
appId string 从API设置中获取,在直播系统登记的appId
sign string 签名,为32位大写的MD5值
timestamp string 当前13位毫秒级(兼容10位秒级)时间戳,3分钟内有效

响应成功JSON示例:

{
    status: "success",
    result: [
    {
        playId: "1466737508948X1585577",
        userId: "edvf2fpec9",
        channelId: 101385,
        playDuration: 82,
        stayDuration: 84,
        flowSize: 3182842,
        sessionId: "",
        param1: "84261eee56664383840a585c7fb359eb",
        param2: "广州观众/53049",
        param3: "live",
        param4: "",
        param5: "",
        ipAddress: "121.33.51.211",
        country: "中国",
        province: "广东",
        city: "广州",
        isp: "",
        referer: "http://live.videocc.net/watch/101385",
        userAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36",
        operatingSystem: "Windows 7",
        browser: "Chrome",
        isMobile: "N",
        currentDay: "2016-06-24",
        createdTime: 1467014780000,
        lastModified: 1467049716000
    }
    ]
}

响应异常JSON示例:

{
    status: "app_not_found",
    result: "application not found."
}

字段说明

字段 说明
playId 表示此次播放动作的ID
userId 用户ID
channelId 频道号
playDuration 播放时长
stayDuration 缓存时长
flowSize 流量大小
sessionId 用户自定义参数,如学员ID等
param1/2/3/4/5 POLYV系统参数
ipAddress IP地址
country 国家
province 省份
city 城市
isp ISP运营商
referer 播放视频页面地址
userAgent 用户设备
operatingSystem 操作系统
browser 浏览器
isMobile 是否为移动端
currentDay 日志查询日期 (格式为:yyyy-MM-dd)
createdTime 日志创建日期 (13位时间戳)
lastModified 日志更新日期 (13位时间戳)

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$channelId = "101385";
$currentDay = "2016-06-12";//查询的日期,格式:yyyy-MM-dd
$param1 = "8b1ed9db009948a7987fb8af4db5639f";//用户ID

$params = array(
    'appId'=>$appId,
    'userId'=>$userId,
    'currentDay'=>$currentDay,
    'param1'=>$param1,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
//接口请求url
$url = "http://api.live.polyv.net/v1/statistics/$channelId/viewlog?appId=$appId&currentDay=$currentDay&param1=$param1&timestamp=$timestamp&userId=$userId&sign=$sign";

//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

查询频道实时在线人数

接口URL

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

接口说明

1、在直播中,获取实时观看的人数
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级(兼容10位秒级)时间戳,3分钟内有效
userId string 直播账号ID
sign string 签名,为32位大写的MD5值

响应成功JSON示例:

{
  status: "success",
  result: [
    {
      time: "04:01:38",
      count: "0"
    },
    {
      time: "04:01:30",
      count: "1"
    },
    {
      time: "04:01:22",
      count: "2"
    },
    {
      time: "04:01:14",
      count: "2"
    },
    {
      time: "04:01:06",
      count: "2"
    },
    {
      time: "04:00:58",
      count: "1"
    },
    {
      time: "04:00:50",
      count: "1"
    },
    {
      time: "04:00:42",
      count: "2"
    },
    {
      time: "04:00:34",
      count: "2"
    },
    {
      time: "04:00:26",
      count: "2"
    },
    {
      time: "04:00:18",
      count: "1"
    },
    {
      time: "04:00:10",
      count: "2"
    },
    {
      time: "04:00:02",
      count: "2"
    },
    {
      time: "03:59:54",
      count: "3"
    },
    {
      time: "03:59:46",
      count: "2"
    }
  ]
}

响应异常JSON示例:

{
   code: "invalid_argument",
   msg: "userId is blank."
}

字段说明

参数名 类型 说明
status string 状态值
result string 相应的结果
time string 统计的时间点(时间格式:12H)
count string 某个时间点实时观看人数

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

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$channelId = "127073";

$params = array(
    'appId'=>$appId,
    'userId'=>$userId,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.live.polyv.net/v1/statistics/$channelId/realtime?appId=".$appId."&timestamp=".$timestamp."&userId=".$userId."&sign=".$sign;

//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...