分页查询频道观看日志

接口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
startTime 请查看下方注意点 string 查询开始时间,为13位毫秒级时间戳
endTime 请查看下方注意点 string 查询结束时间,13位毫秒级时间戳
param1 string 观看用户ID
param2 string 观看用户昵称
param3 string 观看日志类型,取值 vod 表示观看回放,取值live 表示直播
sign string 签名,32位大写MD5值

注意
1. 如果查询一段时间的记录,可以传:startTime、endTime (startTime和endTime 必须在同一个月),如果查询某天的记录,则传currentDay;
2. startTime、endTime 和 currentDay不能都不传;
3. currentDay与startTime、endTime 同时传将使用currentDay的值。

响应成功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 使用POLYV观看页的观众ID
param2 使用POLYV观看页的观众昵称
param3 观看类型:取值 live(直播)、vod(回放)
param4/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...

签名生成规则

一、userId、appId、appSecret值的获取

developer
在直播管理后台,点击开发设置,在显示的页面中获取userId、appId、appSecret值。

二、sign生成规则

将请求所需所有参数按照参数名字典顺序排列,连接参数名与参数值,并在首尾加上appSecret,生成32位大写MD5值,作为sign。

三、Java sign生成示例

String appId = "XXXXXXXX";  
String userId = "XXXXXXXX";  
String appSecret = "XXXXXXXXXXXXXXXXXXXXXXXX";  

long ts = System.currentTimeMillis();
// 创建参数表 (创建接口需要传递的所有参数表)
Map<String, String> paramMap = new HashMap<String, String>();  
paramMap.put("appId", appId);
paramMap.put("timestamp", Long.toString(ts));

//对参数名进行字典排序  
String[] keyArray = paramMap.keySet().toArray(new String[0]);  
Arrays.sort(keyArray);  

//拼接有序的参数串  
StringBuilder stringBuilder = new StringBuilder();  
stringBuilder.append(appSecret);  
for (String key : keyArray)  
{  
stringBuilder.append(key).append(paramMap.get(key));  
}  

stringBuilder.append(appSecret);  
String signSource = stringBuilder.toString(); 

String sign = org.apache.commons.codec.digest.DigestUtils.md5Hex(signSource).toUpperCase();
System.out.println("http://api.polyv.net/live/v1/users/" + userId + "/channels?appId=" + appId + "&timestamp=" + ts + "&sign=" + sign);

四、PHP sign生成示例

1、config.php文件代码

<?php
//签名验证必需参数
$appId = "XXXXXXXXX";
$timestamp = time()*1000;
$appSecret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

//获取sign函数
function getSign($params){
    global $appSecret;
    // 1. 对加密数组进行字典排序
    foreach ($params as $key=>$value){
     $arr[$key] = $key;
    }
    sort($arr);
    $str = $appSecret;
    foreach ($arr as $k => $v) {
     $str = $str.$arr[$k].$params[$v];
    }
    $restr = $str.$appSecret;
    $sign = strtoupper(md5($restr));
    return $sign;
}
?>

2、接口请求示例

<?php

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

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

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

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

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

//输出接口请求结果
$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
//打印获得的数据
print_r($response);

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

合并录制文件

接口URL

https://api.polyv.net/live/v2/channel/recordFile/{channelId}/merge

接口说明

1、作用:合并频道的录制文件
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

请求方式

POST

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
urls 请查看下方说明 string 要合并的录制文件URL,多个文件用英文逗号"," 分开,urls必须为相同格式的文件
fileIds 请查看下方说明 string 要合并的录制文件id,多个文件id用英文逗号"," 分开
fileName string 合并后的文件名
sign string 签名,为32位大写的MD5值

注意:urls 和 fileIds 参数不能同时不传;两个参数都传时,urls生效。

响应参数

参数名 说明
code 响应状态码
status 响应状态
message 异常错误信息
data code 200的时候放回合并后的文件地址,其他情况返回异常错误信息

响应成功JSON示例

{
  code: 200,
  status: "success",
  message: "",
  data: "http://xxxxx/xkx/xxx.m3u8"
}

响应异常JSON示例,签名错误

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

响应异常JSON示例,appId为空

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

响应异常JSON示例,appId不存在

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

响应异常JSON示例,校验的时间过期

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

响应异常JSON示例,签名错误

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

响应异常JSON示例,频道ID不存在

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

响应异常JSON示例,合并的录制文件url为空

{
  code: 403,
  status: "error",
  message: "urls is required.",
  data: ""
}

PHP请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "127075";
$urls="http://xxx.xx/a.mp4,http://xxx.xx/b.mp4";

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

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

//接口请求url
$url="https://api.polyv.net/live/v2/channel/recordFile/$channelId/merge?appId=".$appId."&timestamp=".$timestamp."&urls=".$urls."&sign=".$sign;

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

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

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

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

设置直播状态回调通知url

接口URL

http://api.polyv.net/live/v2/user/{userId}/set-stream-callback

接口说明

1、设置账号下频道直播状态改变通知回调地址的接口
2、不提交地址参数url,则回调地址为空,表示关闭回调功能,如果要提交的地址参数url,必须以 http:// 或者 https:// 开头
3、接口支持https
4、接口URL中的{userId}为 直播账号ID

具体功能可参考:直播状态修改回调通知接口

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
url string 回调地址url,不提交表示关闭回调功能,如果提交,必须以 http:// 或者 https:// 开头

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": ""
}

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

userId错误

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

回调地址给是错误(需带协议头)

{
    "code": 400,
    "status": "error",
    "message": "url format error.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 暂无作用

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$url = "http://demo.polyv.net/wfy/postDemo1.php";

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

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

//接口请求url
$url = "http://api.polyv.net/live/v2/user/$userId/set-stream-callback?appId=$appId&timestamp=$timestamp&sign=$sign&url=$url";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

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

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

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

设置子频道信息

接口URL

https://api.polyv.net/live/v2/channelAccount/{channelId}/update

接口说明

1、通过接口可以设置子频道的昵称、密码、角色、头像、翻页权限、公告权限等
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
account string 子频道ID(不能以数字类型提交,否则可能去掉ID前的00)
nickname string 昵称
password string 子频道密码
avatar string 头像
actor string 子频道头衔
pageTurnEnabled string 子频道翻页权限
notifyEnabled string 子频道公告权限

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "success"
}

响应失败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 请求成功时为success, 请求失败为空

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "127075";
$nickname = "测试助教";
$actor = "老大";
$account = "002127075";

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

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

$url = "http://api.polyv.net/live/v2/channelAccount/$channelId/update?appId=$appId&timestamp=$timestamp&sign=$sign&account=$account&nickname=$nickname&actor=$actor";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

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

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

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

删除子频道

接口URL

http://api.polyv.net/live/v2/channelAccount/{channelId}/delete

接口说明

1、删除某个子频道
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
account string 子频道ID(不能以数字类型提交,否则可能去掉ID前的00)

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

响应失败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 正确请求时为删除结果,删除成功为true,频道已经删除为false

php请求示例

<?php

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

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

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

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

//接口请求url
$url = "http://api.polyv.net/live/v2/channelAccount/$channelId/delete?appId=$appId&timestamp=$timestamp&sign=$sign&account=$account";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

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

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

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

查询频道号下所有子频道信息

接口URL

https://api.polyv.net/live/v2/channelAccount/{channelId}/accounts

接口说明

1、查询频道下所有子频道的具体信息
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "account": "003104400",
            "userId": "edvf2fpec9",
            "channelId": 104400,
            "passwd": "991730",
            "nickname": "王老师",
            "stream": "jdchwdsf",
            "status": "Y",
            "createdTime": 1517972947000,
            "lastModified": 1517972947000,
            "channelSessionId": null,
            "sort": 3,
            "avatar": null,
            "actor": null,
            "pageTurnEnabled": "N",
            "notifyEnabled": "Y",
            "checkinEnabled": "Y",
            "voteEnabled": "Y",
            "lotteryEnabled": "Y",
            "role": "Assistant",
            "pushUrl": "rtmp://push2.videocc.net/record/edvf2fpec920161013182110231jdchwdsf"
        },
        {
            "account": "002104400",
            "userId": "edvf2fpec9",
            "channelId": 104400,
            "passwd": "123",
            "nickname": "测试",
            "stream": "jdbjbjcw",
            "status": "Y",
            "createdTime": 1517914867000,
            "lastModified": 1517914970000,
            "channelSessionId": null,
            "sort": 2,
            "avatar": null,
            "actor": "老大",
            "pageTurnEnabled": "N",
            "notifyEnabled": "Y",
            "checkinEnabled": "Y",
            "voteEnabled": "Y",
            "lotteryEnabled": "Y",
            "role": "Assistant",
            "pushUrl": "rtmp://push2.videocc.net/record/edvf2fpec920161013182110231jdbjbjcw"
        }
    ]
}

响应失败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 用户的分钟数相关信息
account 助教ID
userId 用户ID
channelId 频道ID
passwd 助教密码
nickname 助教名称
stream 助教流名(单独使用无效)
status 助教状态
createdTime 创建助教时间
lastModified 助教最后修改时间
sort 频道中所有助教序号
avatar 助教头像
pageTurnEnabled 助教翻页权限(只能一个助教有)
notifyEnabled 发布公告权限
checkinEnabled 开启签到权限
voteEnabled 发起投票
role 子频道角色
pushUrl 子频道推流地址(子频道推流请参考后台导播台使用)

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/channelAccount/$channelId/accounts?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

https://api.polyv.net/live/v2/channelAccount/{channelId}/add

接口说明

1、创建子频道
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

POST

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
role string 默认不传为助教,传Guest为嘉宾
nickname string 创建的助教或嘉宾昵称
actor string 创建的助教或嘉宾头衔
avatar string 创建的助教或嘉宾头像

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "account": "004104400",
        "userId": "edvf2fpec9",
        "channelId": 104400,
        "passwd": "150751",
        "nickname": "张老师",
        "stream": "jdci3mre",
        "status": "Y",
        "createdTime": 1517973284858,
        "lastModified": 1517973284858,
        "channelSessionId": null,
        "sort": 4,
        "avatar": null,
        "actor": null,
        "pageTurnEnabled": "N",
        "notifyEnabled": "Y",
        "checkinEnabled": null,
        "voteEnabled": null,
        "lotteryEnabled": null,
        "role": null
    }
}

响应失败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 错误信息
account 助教ID
userId 用户ID
channelId 频道ID
passwd 助教密码
nickname 助教名称
stream 助教流名(单独使用无效)
status 助教状态
createdTime 创建助教时间
lastModified 助教最后修改时间
sort 频道中所有助教序号
avatar 助教头像
pageTurnEnabled 助教翻页权限(只能一个助教有)
notifyEnabled 发布公告权限
checkinEnabled 开启签到权限
voteEnabled 发起投票
role 子频道角色

php请求示例

<?php
//签名验证必需参数
//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$nickname = "助教昵称";
$avatar = "http://livestatic.videocc.net/v_556/assets/wimages/missing_face.png";
$actor = "助教头衔";
$channelId="160256";

$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp,
    'avatar'=>$avatar,
    'actor'=>$actor,
    'nickname'=>$nickname
  );
//获取sign函数


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

$data = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp,
    'avatar'=>$avatar,
    'actor'=>$actor,
    'nickname'=>$nickname,
    'sign'=>$sign
);

$url = "https://api.polyv.net/live/v2/channelAccount/$channelId/add";
$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt( $ch, CURLOPT_POSTFIELDS, $data);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );

echo $response;

?>

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

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

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

查询子频道信息

接口URL

https://api.polyv.net/live/v2/channelAccount/{channelId}/account

接口说明

1、查询某个子频道的具体信息
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
account string 子频道ID(不能以数字类型提交,否则可能去掉ID前的00)

响应成功JSON示例:

{
    code: 200,
    status: "success",
    message: "",
    data: {
        account: "0039108888",
        userId: "edvf2fpec9",
        channelId: 108888,
        passwd: "508621",
        nickname: "彭老师",
        stream: "jdbh0dv7",
        status: "Y",
        createdTime: 1517910988000,
        lastModified: 1517910988000,
        channelSessionId: null,
        sort: 39,
        avatar: null,
        actor: null,
        pageTurnEnabled: "N",
        notifyEnabled: "Y",
        checkinEnabled: "Y",
        voteEnabled: "Y",
        lotteryEnabled: "Y",
        role: "Assistant",
        pushUrl: "rtmp://push2.videocc.net/record/edvf2fpec920160418183933972jdbh0dv7"
    }
}

响应失败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 错误信息
account 子频道ID
userId 用户ID
channelId 频道ID
passwd 子频道密码
nickname 子频道名称
stream 子频道流名(单独使用无效)
status 子频道状态
createdTime 创建子频道时间
lastModified 子频道最后修改时间
sort 频道中所有子频道序号
avatar 子频道头像
pageTurnEnabled 子频道翻页权限(只能一个子频道有)
notifyEnabled 发布公告权限
checkinEnabled 开启签到权限
voteEnabled 发起投票
role 子频道角色
pushUrl 子频道推流地址(子频道推流请参考后台导播台使用)

php请求示例

<?php

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

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

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

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

//接口请求url
$url = "http://api.polyv.net/live/v2/channelAccount/$channelId/account?appId=$appId&timestamp=$timestamp&sign=$sign&account=$account";

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

?>

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

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

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

设置转存成功回调通知url

接口URL

http://api.polyv.net/live/v2/user/{userId}/set-playback-callback

接口说明

1、设置账号下转存回放视频成功通知回调地址的接口
2、不提交地址参数url,则回调地址为空,表示关闭回调功能,如果要提交的地址参数url,必须以 http:// 或者 https:// 开头
3、接口支持https
4、接口URL中的{userId}为直播账号ID

具体功能可参考:转存成功回调通知接口

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
url string 回调地址url,不提交表示关闭回调功能,如果提交,必须以 http:// 或者 https:// 开头

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": ""
}

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

userId错误

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

回调地址给是错误(需带协议头)

{
    "code": 400,
    "status": "error",
    "message": "url format error.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 暂无作用

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$url = "http://demo.polyv.net/wfy/postDemo1.php";

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

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

//接口请求url
$url = "http://api.polyv.net/live/v2/user/$userId/set-playback-callback?appId=$appId&timestamp=$timestamp&sign=$sign&url=$url";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

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

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

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