获取多个频道的实时在线人数

接口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分钟(8秒一个点,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/user/{userId}/get-income-detail

接口说明

1、得到的数据相当于直播后台财务中心--收入详情(http://live.polyv.net/secure/finance/income.htm)的数据
2、接口URL中的{userId}为 直播账号ID
3、根据是否提交channelId来获取全部频道/某个频道的收入详情数据
4、接口支持https

支持格式

JSON

请求方式

GET、POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
startDate string 查询的开始日期 格式为yyyy-MM-dd
endDate string 查询的结束日期 格式为yyyy-MM-dd
channelId int 要查询的频道ID,不提交默认为查询所有频道
page int 查询第几页记录,不提交默认为1
pageSize int 每页显示的记录数,不提交默认为12

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": {
        "pageNumber": 1, 
        "totalItems": 2, 
        "contents": [
            {
                "amount": 0.01, 
                "channelId": 108888, 
                "payType": "good", 
                "payTypeName": "道具打赏", 
                "viewerName": "广州观众/17914", 
                "payTime": 1495441670000, 
                "outTradeNo": "4008262001201705222058849969"
            }, 
            {
                "amount": 0.01, 
                "channelId": 108888, 
                "payType": "good", 
                "payTypeName": "道具打赏", 
                "viewerName": "珠海观众/18040", 
                "payTime": 1490681792000, 
                "outTradeNo": "4008262001201703284937190753"
            }
        ], 
        "offset": 0, 
        "limit": 2, 
        "endRow": 2, 
        "firstPage": true, 
        "totalPages": 1, 
        "prePageNumber": 1, 
        "lastPage": true, 
        "startRow": 1, 
        "nextPageNumber": 1
    }
}

响应失败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": ""
}

频道号不属于当前账号

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

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
pageNumber 当前页
totalItems 记录的总数
amount 金额
payType 收入类型:good、cash、pay
payTypeName 收入类型的名称:道具打赏、现金打赏、付费观看
viewerName 付费观众昵称
payTime 付费时间
outTradeNo 保利威视系统内部订单号
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一条记录在总记录中的位置
endRow 当前页最后一个记录在总记录中的位置
limit 当前页纪录数
offset 当前页第一条记录在总记录中的位置

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$startDate = "2017-09-11";
$endDate = "2018-03-08";
$channelId = 127075;
$page = 1;
$pageSize = 15;

$params = array(
    'appId'=>$appId,
    'startDate'=>$startDate,
    'endDate'=>$endDate,
    'channelId'=>$channelId,
    'page'=>$page,
    'pageSize'=>$pageSize,
    'timestamp'=>$timestamp
  );

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

//接口请求url
$url = "http://api.polyv.net/live/v2/user/".$userId."/get-income-detail?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign."&endDate=".$endDate."&startDate=".$startDate."&channelId=".$channelId."&page=".$page."&pageSize=".$pageSize;
//输出接口请求结果
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/stream/{channelId}/capture

接口说明

1、截图功能,获取当前频道或子频道正在直播的截图(截图五分钟更新一次)
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

GET  POST

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data":"//livestatic.videocc.net/uploaded/images/2018/01/ex96has7bf.jpg"
}

响应失败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": "account not exists.",
    "data": ""
}

频道不存在

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

子频道未直播

{
    "code": 400,
    "status": "error",
    "message": "account is not live.",
    "data": ""
}

频道未直播

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

获取图片失败

{
    "code": 400,
    "status": "error",
    "message": "get capture image failure.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求成功时截图地址,请求错误时为空

php请求示例

<?php

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

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

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

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

//接口请求url

$url = "http://api.polyv.net/live/v2/stream/".$channelId."/capture?appId=".$appId."&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、得到的数据相当于直播后台按频道汇总(http://live.polyv.net/secure/userstats/channel_summary.htm)的数据
2、根据是否提交channelIds来获取全部频道/某个频道的播放数据
3、接口URL中的{userId}为直播账号ID
4、接口支持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/user/get-user-durations

接口说明

1、获取用户历史已经使用的分钟数及当前可用的分钟数
2、接口支持https协议

支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
     "userId": "edv3kno3t5",
     "available": 47583,
     "used": 37398
    }
}

响应失败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 请求状态响应码
status 请求状态
message 错误信息
data 用户的分钟数相关信息
data.userId 用户ID,字符串
data.available 当前可用的分钟数,长整型
data.used 历史已经使用的分钟数,长整型

php请求示例

<?php

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


/接口需要的参数(非sign)赋值
$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp
  );

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

//接口请求url
$url = "http://api.live.polyv.net/v2/user/get-user-durations?appId=".$appId."&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/{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
mobileUniqueViewer 移动端唯一观众数,类似UV
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/v2/channels/{channelId}/get

接口说明

1、查询直播频道
2、接口URL中的{channelId}为 频道ID
3、接口支持https协议

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
code: 200,
status: "success",
message: "",
data: {
channelId: 124545,
userId: "7d26575efe",
name: "测试频道号",
publisher: "",
description: "",
url: "rtmp://push2.videocc.net/recordf/7d26575efe20170612103055370",
stream: "7d26575efe20170612103055370",
logoImage: "http://livestatic.videocc.net/uploaded/images/2017/11/evg58gdou1.png",
logoOpacity: 1,
logoPosition: "tr",
logoHref: "http://www.baidu.com",
coverImage: "",
coverHref: "",
waitImage: "",
waitHref: "",
cutoffImage: "",
cutoffHref: "",
advertType: "NONE",
advertDuration: 5,
advertWidth: 400,
advertHeight: 300,
advertImage: "http://livestatic.videocc.net/uploaded/images/2017/11/evg5b6e5jq.jpg",
advertHref: "http://",
advertFlvVid: "",
advertFlvUrl: "http://mpv.videocc.net/93da9a3b70/e/93da9a3b70585268f2d8b8db53c8fa3e_1.flv",
playerColor: "#00ffff",
autoPlay: true,
warmUpFlv: "",
passwdRestrict: false,
passwdEncrypted: "",
isOnlyAudio: "N",
isLowLatency: "N",
m3u8Url: "http://pullh.videocc.net/recordf/7d26575efe20170612103055370/playlist.m3u8?wsSecret=4ea0829f7427c7681ee2cdb7fae1b3cb&wsTime=1522824959",
m3u8Url1: "",
m3u8Url2: "",
m3u8Url3: "",
channelLogoImage: "http://livestatic.videocc.net/uploaded/images/2017/07/eruyc245uj.png",
currentTimeMillis: 1522824959038
}
}

字段说明

参数名 类型 说明
status string 状态值
result object 响应的结果
channelId string 直播频道ID
userId string 直播用户ID
name string 直播频道名称
description string 直播频道描述
url string 直播推流地址
stream string 直播流名称
logoImage string 播发器logo
logoOpacity int Logo不透明度,1表示完全不透明
logoPosition string Logo位置
logoHref string Logo的跳转链接
coverImage string 播放前显示的封面图
coverHref string 封面图的跳转链接
waitImage string 等待推流时的显示图片
waitHref string 等待推流时显示图片的跳转链接
cutoffImage string 切断流时的显示图片
cutoffHref string 切断流时显示图片的跳转链接
advertType string 广告类型
advertDuration string 广告时长
advertWidth string 广告区域宽度
advertHeight string 广告区域高度
advertImage string 图片广告
advertHref string 广告的跳转链接
advertFlvVid string 视频广告ID
advertFlvUrl string 视频广告链接
playerColor string 播放器控制栏颜色
autoPlay boolean 自动播放
warmUpFlv string 一开始的暖场视频
passwdRestrict boolean 观看密码限制,需要输入观看密码才能播放流
passwdEncrypted string 观看密码加密后的密文
isOnlyAudio string 仅推音频流
isLowLatency string 低延迟
m3u8Url string 直播拉流(播放)m3u8地址
m3u8Url1 string 直播拉流(播放)m3u8地址1
m3u8Url2 string 直播拉流(播放)m3u8地址2
m3u8Url3 string 直播拉流(播放)m3u8地址3
currentTimeMillis timestamp 服务器返回的时间戳(毫秒)
channelLogoImage string 频道的图标
code string 异常错误代码
msg string 异常消息
publisher string 主持人姓名

php请求示例

<?php

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

//接口URL上变量
$channelId = "124545";
//接口需要的参数(非sign)赋值
$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp
  );

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

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

?>

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

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

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

获取频道观看条件信息

请求地址

http://api.polyv.net/live/v2/channelSetting/{channelId}/watchAuth

接口说明

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

请求方式

GET

请求参数

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

响应成功JSON示例

{
  1. 无限制: {
    code: 200, 
    status: "success",
    message: "",
    data: {
    authType: "none",
    channelId: 110895
  }
  }
  authType:为观看条件的类型
  2. 验证码观看: {
    code: 200,
    status: "success",
    message: "",
    data: {
    authType: "code",    //授权类型,此处为验证码
    channelId: 110895,
    authTips: "提示文字",   //出现的提示文字
    authCode: "验证码",     //验证码内容
    qcodeEnabled: "Y",      //开启二维码
    qcodeImg: "",           //二维码图片
    qcodeTips: "",          //提示扫描二维码的文字
    shareViewable: "N"     //是否分享可观看
  }
  }
  3. 付费观看:{
    code: 200,
    status: "success",
    message: "",
    data: {
      authType: "pay",
      channelId: 101385,
      authTips: "提示文字",
      price: "909.00",       //付费价格
      validTimeEnabled: "Y",   //是否开启截止时间
      watchEndTime: 1489823715000, //观看截止时间
      shareViewable: "Y",       //是否分享可观看
      mixPayPhoneEnabled: "N",  //是否同时开启白名单
      phoneWhties:[
        {           //白名单具体信息
        channelId: 101385,
        phone: "13712345678",
        userId: "edvf2fpec9",
        name: "你好",
        isVip: "N",
        createdTime: 1489371356000,
        lastModified: 1489371356000
      },
      {
        channelId: 101385,
        phone: "测试测试",
        userId: "edvf2fpec9",
        name: "测试测试",
        isVip: "N",
        createdTime: 1489371356000,
        lastModified: 1489371356000
      },
      {
        channelId: 101385,
        phone: "13212345678",
        userId: "edvf2fpec9",
        name: "马",
        isVip: "N",
        createdTime: 1489371356000,
        lastModified: 1489371356000
      }
      ]
    }
  }
  4. 白名单观看:
  {
    code: 200,
    status: "success",
    message: "",
    data: {
      authType: "phone",
      channelId: 101385,
      authTips: "欢迎观看本直播",
      whitelistEnabled: "Y",      //是否开启白名单
      phoneWhties: [ {            //phoneWhties:白名单的相关信息
      {
        channelId: 101385,
        phone: "你好",
        userId: "edvf2fpec9",
        name: "你好",
        isVip: "N",
        createdTime: 1489371356000,
        lastModified: 1489371356000
      },
      {
        channelId: 101385,
        phone: "测试测试",
        userId: "edvf2fpec9",
        name: "测试测试",
        isVip: "N",
        createdTime: 1489371356000,
        lastModified: 1489371356000
      },
      {
        channelId: 101385,
        phone: "hello",
        userId: "edvf2fpec9",
        name: "hello",
        isVip: "N",
        createdTime: 1489371356000,
        lastModified: 1489371356000
      }
      ],
      shareViewable: "Y"
    }
  }
  5. 自定义授权观看:{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
    "authType": "custom",
    "channelId": 110895,
    "customUri": "http:www.test.demo.php",  //用户自定义地址
    "customKey": "SEdkpodDck"               //频道号secretkey
  }
  }
  6. 登记观看:{
    code: 200,
    status: "success",
    message: "",
    data: {
    authType: "info",
    channelId: 101385,
    infoFieldEnabled1: "Y",              //是否启用该字段
    infoFieldName1: "字段1",             //字段名称
    infoFieldPlaceholder1: "字段1字段1字段1字段1", //字段描述
    infoFieldType1: "text",              //字段类型
    infoFieldOption1: "",                //下拉选择项,如为字段类型为text和number时,此字段为空
    infoFieldEnabled2: "Y",
    infoFieldName2: "字段2",
    infoFieldPlaceholder2: "字段2字段2字段2字段2",
    infoFieldType2: "number",
    infoFieldOption2: "",
    infoFieldEnabled3: "Y",
    infoFieldName3: "字段3",
    infoFieldPlaceholder3: "字段3字段3字段3字段3",
    infoFieldType3: "option",
    infoFieldOption3: "1,2,3,4,5",
    infoFieldEnabled4: "N",
    infoFieldName4: "",
    infoFieldPlaceholder4: "",
    infoFieldType4: "",
    infoFieldOption4: "",
    infoFieldEnabled5: "",
    infoFieldName5: null,
    infoFieldPlaceholder5: "",
    infoFieldType5: "",
    infoFieldOption5: "",
    shareViewable: "N"
  }
  }
  7. 外部授权观看:{
    code: 200,
    status: "success",
    message: "",
    data: {
    authType: "external",
    channelId: 125527,
    "externalUri": "http://demo.polyv.net/chenwb/live-validate2.php",  //用户自定义地址
    "externalKey": "L0EjokKI4O"               //频道号secretkey
  }
  }

响应异常JSON示例

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

PHP请求示例

<?php

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

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

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

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

//接口请求url
$url = "http://api.live.polyv.net/v2/channelSetting/".$channelId."/watchAuth?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...

获取频道号列表

接口URL

http://api.polyv.net/live/v1/users/{userId}/channels

接口说明

1、查询频道号列表
2、接口URL中的{userId}为 直播账号ID
3、接口支持https协议

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON

{
   status: "success",
   result: [ 
       104170,
       104100,
       104099,
       104018,
       103485,
       103328,
       101599,
       101594,
       101378
  ] 
}

响应异常JSON示例:

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

字段说明

参数名 说明
status 响应状态
result 响应结果
code 异常错误代码
msg 异常错误信息

php请求示例

<?php

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

//接口URL上变量
$userId = "XXXXXXXXX";
//接口需要的参数(非sign)赋值
$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp
  );

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

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

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

?>

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

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

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