查询账户分钟数

接口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
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...

获取频道号列表

接口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...

获取频道观看日志

接口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 某个时间点实时观看人数

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...

获取频道直播状态

接口URL

http://api.polyv.net/live_status/query

接口说明

1、作用:获取频道直播状态
2、接口支持https协议

请求方式

GET

请求参数限制

true

请求参数

参数名 必选 类型 说明
stream string 可调用获取频道信息接口,获取stream字段的值

返回结果

如果正在直播,返回live,否则返回end。

请求示例:http://api.polyv.net/live_status/query?stream=eciyhturt820160305194727292

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