新增子频道

接口URL

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

接口说明

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

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

响应成功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)赋值
$channelId = "127075";

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

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

$url = "http://api.polyv.net/live/v2/channelAccount/$channelId/add?appId=$appId&timestamp=$timestamp&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

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"
    }
}

响应失败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)赋值
$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

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

修改倒计时设置

接口URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/set-countdown

接口说明

1、通过接口可以修改频道的倒计时设置。
2、预约功能需开启开关且开启倒计时开关以及设置正确的直播时间才生效
3、之前未设置倒计时直播提示和直播时间的频道号,在开启倒计时开关时,必须提交countTips和startTime
4、接口支持https
5、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
countEnabled Y 或 N 倒计时开关
bookingEnabled Y或 N 预约观看开关
countTips string(长度不能大于10) 直播倒计时提醒文字
startTime string(yyyy-MM-dd HH:mm:ss) 直播开始时间
sign string 签名,32位大写MD5值

响应成功JSON示例:

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

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId not found.",
    "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": "channel not found.",
    "data": ""
}

倒计时开关错误(不是Y或N)

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

开启开关且之前未设置过直播提示时,未提交countTips

{
    "code": 400,
    "status": "error",
    "message": "countTips is requeired under this condition.",
    "data": ""
}

其他情况

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

字段说明

参数名 说明
code 请求结果代码,成功为200
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空,错误时错误信息

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "127075";
$countEnabled = "Y";
$bookingEnabled = "Y";
$startTime = "2018-02-15 10:00:00";
$countTips = "精彩值得等待";

$params = array(
    'appId'=>$appId,
    'bookingEnabled'=>$bookingEnabled,
    'countEnabled'=>$countEnabled,
    'countTips'=>$countTips,
    'startTime'=>$startTime,
    'timestamp'=>$timestamp
  );

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

$data = array(
      'appId' => $appId,
      'countEnabled' => $countEnabled,
      'timestamp' => $timestamp,
      'sign' => $sign,
      'bookingEnabled' => $bookingEnabled,
      'countTips' => $countTips,
      'startTime' => $startTime
  );

$url = "http://api.polyv.net/live/v2/channelSetting/$channelId/set-countdown";
$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);
$reponse = curl_exec ( $ch );
curl_close ( $ch );
print_r($reponse); 

?>

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

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

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

获取倒计时设置信息

接口URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/get-countdown

接口说明

通过接口可以获取倒计时设置的相关信息;
接口支持https
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    code: 200,
    status: "success",
    message: "",
    data: {
        bookingEnabled: "N",
        countTips: "不要急,精彩值得等待",
        countEnabled: "N",
        startTime: "2018-12-01 15:00:00"
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId not found.",
    "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": "channel not found.",
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200
status 请求结果,成功时为"success"错误时为"error"
countEnabled 倒计时开关(Y/N)
bookingEnabled 预约开关(Y/N)
countTips 直播提示文字
startTime 直播开始时间

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/channelSetting/$channelId/get-countdown?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/user/{userId}/set-record-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/postDemo.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-record-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

http://api.polyv.net/live/v2/channel/recordFile/{channelId}/delete-record

接口说明

1、根据开始录制时间删除频道下对应的的录制视频
2、提交的开始录制时间参数(startTime)格式与
【获取频道录制视频信息】接口中获取的返回结果的时间格式一致,为 yyyyMMddHHmmss,如:20180126174943
3、接口支持https
4、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
startTime string 录制视频的开始录制时间,可从 获取频道录制信息接口中获取

响应成功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": ""
}

startTime格式错误

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

无对应时间的录制视频

{
    "code": 400,
    "status": "error",
    "message": "record file not exist.",
    "data": ""
}

字段说明

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

php请求示例

<?php

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

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

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

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

//接口请求url
$url="http://api.polyv.net/live/v2/channel/recordFile/$channelId/delete-record?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign."&startTime=".$startTime;

$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/channels/{channelId}/update-like

接口说明

1、设置频道的点赞数和观看人数
2、接口支持https
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

GET  POST

请求数限制

TRUE

请求参数

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

响应成功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": ""
}

未提交viewers或likes

{
    "code": 400,
    "status": "error",
    "message": "likes and viewers is required.",
    "data": ""
}

字段说明

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

php请求示例

<?php

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

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

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

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

//接口请求url
$url = "http://api.polyv.net/live/v2/channels/$channelId/update-likes?appId=$appId&timestamp=$timestamp&sign=$sign&likes=$likes&viewers=$viewers";

//输出接口请求结果
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、接口URL中的{userId}为 直播账号ID
2、根据是否提交channelId来获取全部频道/某个频道的收入详情数据
3、接口支持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...