设置暂停广告的接口

接口URL

http://api.polyv.net/live/v2/channelAdvert/{channelId}/updateStop

接口说明

1、接口用于设置某频道播放器的暂停广告
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
enabled string Y-打开,N-关闭;设置开关时,其余设置参数无效
stopAdvertImage string 图片地址,不填代表删除
stopAdvertHref string 点击图片跳转Url

响应成功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": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

开关参数错误

{
    "code": 400,
    "status": "error",
    "message": "invalid enabled value",
    "data": ""
}

非法请求

{
    "code": 403, 
    "status": "error", 
    "message": "operation forbidden.", 
    "data": ""
}

字段说明

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

php请求示例

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

$stopAdvertImage = "http://www.image.com";
$stopAdvertHref = "http://www.href.com";
$channelId="123713";

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

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


$url="http://api.polyv.net/live/v2/channelAdvert/".$channelId."/updateStop";

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

$params["sign"] = $sign;
echo post($url, $params);
?>

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

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

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

设置片头广告的接口

接口URL

http://api.polyv.net/live/v2/channelAdvert/{channelId}/updateHead

接口说明

1、接口用于设置某频道播放器的片头广告
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
enabled string Y-开启,N-关闭;设置开关时,其余设置参数无效
headAdvertType string 广告类型,NONE-无广告,IMAGE-图片广告,FLV-视频广告
headAdvertMediaUrl string 广告地址
headAdvertHref string 广告跳转地址
headAdvertDuration int 广告时长
headAdvertWidth int 广告宽度
headAdvertHeight int 广告高度

响应成功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": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

频道类型错误

{
    "code": 400,
    "status": "error",
    "message": "invalid advert type",
    "data": ""
}

开关参数错误

{
    "code": 400,
    "status": "error",
    "message": "invalid enabled value",
    "data": ""
}

非法请求

{
    "code": 403, 
    "status": "error", 
    "message": "operation forbidden.", 
    "data": ""
}

字段说明

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

php请求示例

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

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

$headAdvertType = "none";
$headAdvertMediaUrl = "http://www.headAdvertMediaUrl.com";
$headAdvertHref = "http://www.headAdvertHref.com";
$headAdvertDuration = 50;
$headAdvertWidth = 100;
$headAdvertHeight = 200;

$params = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'headAdvertType' => $headAdvertType,
    'headAdvertMediaUrl' => $headAdvertMediaUrl,
    'headAdvertHref' => $headAdvertHref,
    'headAdvertDuration' => $headAdvertDuration,
    'headAdvertWidth' => $headAdvertWidth,
    'headAdvertHeight' => $headAdvertHeight
  );

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


$url="http://api.polyv.net/live/v2/channelAdvert/".$channelId."/updateHead";

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

$params["sign"] = $sign;
echo post($url, $params);
?>

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

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

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

获取频道观看条件接口

接口URL

https://api.polyv.net/live/v2/channelsetting/{channelId}/watch-auth

接口说明

1、获取频道设置的观看条件
2、channelId为频道ID

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"channelId": 188194,
"rank": 1,
"userId": "ec7paqepj3",
"globalSettingEnabled": "N",
"authType": "info",
"authTips": "欢迎观看本直播",
"payAuthTips": "欢迎观看本直播",
"authCode": null,
"qcodeTips": null,
"qcodeImg": null,
"price": 1,
"watchEndTime": null,
"validTimePeriod": null,
"customKey": "",
"customUri": null,
"externalKey": "",
"externalUri": null,
"externalRedirectUri": null,
"whiteList": null,
"infoField": {
"channelFieldEnabled1": "N",
"channelFieldName1": "欢迎观看本直播",
"channelFieldPlaceholder1": "ssssss",
"channelFieldType1": "text",
"channelFieldOption1": null,
"channelFieldEnabled2": "N",
"channelFieldName2": "sss",
"channelFieldPlaceholder2": "fff",
"channelFieldType2": "number",
"channelFieldOption2": null,
"channelFieldEnabled3": "N",
"channelFieldName3": "",
"channelFieldPlaceholder3": "",
"channelFieldType3": "",
"channelFieldOption3": "",
"channelFieldEnabled4": "N",
"channelFieldName4": "",
"channelFieldPlaceholder4": "",
"channelFieldType4": "",
"channelFieldOption4": "",
"channelFieldEnabled5": "N",
"channelFieldName5": "",
"channelFieldPlaceholder5": "",
"channelFieldType5": "",
"channelFieldOption5": ""
}
},
{
"channelId": 188194,
"rank": 2,
"userId": "ec7paqepj3",
"globalSettingEnabled": "N",
"authType": "phone",
"authTips": "欢迎观看本直播",
"payAuthTips": "欢迎观看本直播",
"authCode": null,
"qcodeTips": null,
"qcodeImg": null,
"price": 0,
"watchEndTime": null,
"validTimePeriod": null,
"customKey": "",
"customUri": null,
"externalKey": "",
"externalUri": null,
"externalRedirectUri": null,
"whiteList": [
{
"name": "",
"phone": "1",
"isVip": "N"
},
{
"name": "",
"phone": "10",
"isVip": "N"
},
{
"name": "",
"phone": "11",
"isVip": "N"
},
{
"name": "",
"phone": "12",
"isVip": "N"
}
],
"infoFieldModel": 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 错误信息
data 观看条件相关信息
channelId 频道ID,整型
rank 1为主要观看条件,2位次要观看条件
userId 账号ID,字符串
globalSettingEnabled 是否开启全局设置,Y开启,N没有开启
authType 观看条件类型,none为无限制,code为验证码,phone为手机白名单,pay付费观看,custom自定义授权,info登记观看,external外部授权,wxshare微信分享观看
authTips 提示文案,字符串
payAuthTips 付费观看的提示文案,字符串
authCode 验证码,字符串
qcodeTips 验证码观看的提示文案,字符串
qcodeImg 验证码观看的微信公众二维码,字符串
price 付费观看的价格,字符串
watchEndTime 付费观看的有效时间,13位的时间戳
validTimePeriod 付费观看的有效时间,整型,10表示付费后10天内有效
customKey 自定义授权的key
customUri 自定义授权的url
externalKey 外部授权的key
externalUri 外部授权的url
externalRedirectUri 外部授权的错误的跳转页面地址
whiteList 手机白名单观看的白名单列表
whiteList.name 白名单昵称
whiteList.phone 白名单的手机号
whiteList.isVip 白名单是否VIP
infoField 登记观看的字段信息
infoField.channelFieldEnabled1 字段1是否开启
infoField.channelFieldName1 字段1的字段名称
infoField.channelFieldPlaceholder1 字段1提示语
infoField.channelFieldType1 字段1的类型
infoField.channelFieldOption1 字段1的下拉内容

php请求示例

<?php

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

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

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

//接口请求url
$url = "http://api.live.polyv.net/v2/channelsetting/127075/watch-auth?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/channel/{channelId}/update-consulting-enabled

接口说明

1、通过调用接口,可以开启或关闭咨询提问功能菜单
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

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

字段说明

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

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "127075";
$enabled = "Y";
$timestamp = time() * 1000;

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

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

//输出接口请求结果
//接口请求url
$url = "http://api.polyv.net/live/v2/channel/".$channelId."/update-consulting-enabled?appId=".$appId."&enabled="."$enabled"."&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/channelRestrict/{channelId}/set-max-viewer

接口说明

1、设置频道最大观看在线人数
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

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

用户ID为空

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

最大在线人数错误

{
    "code": 400,
    "status": "error",
    "message": "maxViewer is less than or equal to 0.",
    "data": ""
}

设置失败

{
    "code": 400,
    "status": "error",
    "message": "设置失败",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求结果

php请求示例

<?php

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

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

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


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

//接口请求url
$url="http://api.polyv.net/live/v2/channelRestrict/$channelId/set-max-viewer?appId=".$appId."&timestamp=".$timestamp."&userId=".$userId."&maxViewer=".$maxViewer."&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

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

直播播放器音/视频模式切换

POLYV直播播放器,可以进行音视频观看模式的切换。
视频模式:即播放器中即播放音频也播放视频。
音频模式:即播放器中仅播放音频,音频模式对比视频模式播放其中一个优点是加载快,节省流量,缺点是不能观看直播内容,直播效果稍欠缺。

播放器调用示例

<div id="e8888b74d1229efec6b4712e17cb6b7a_e"></div>
<script src="//player.polyv.net/script/player.js"></script>
<script>
  var player = polyvPlayer({
    wrap: '#e8888b74d1229efec6b4712e17cb6b7a_e',
    width: 800,
    height: 533,
    vid: 'e8888b74d1229efec6b4712e17cb6b7a_e',
    useAudio: true
  });
</script>

选项

useAudio

类型:Boolean

说明:默认播放模式 ,可设置为 true/false 。设置为false或者不设置则使用视频模式播放,设置为true则使用音频模式播放。

实例方法

player.switchMMode(type)

参数:type

类型:String

说明:播放模式,可设置为 audio/video。分别为音频模式播放和视频模式播放。

实现效果

效果一:

效果二:

实现此效果可切换到音频模式播放时将播放器父容器高度设置为0,并在页面设置自定义样式。

ps:部分安卓手机切换到音频模式时,音量会变小。由于硬件原因,并且不能通过js控制video/audio标签音量,暂时无法解决。

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

点赞接口

接口URL

http://api.polyv.net/live/v2/channels/{channelId}/like

接口说明

1、用于实现用户自开发观看页点赞效果,通过调用接口可以进行点赞,默认每次请求都是一次点赞
2、接口内部进行了判断,每个观众的点赞间隔1s的限制,根据提交的观众ID来区分
3、如果有需求支持同时点多个赞,可提交非必填参数times,times最大不能超过30。*如果提交次数为n,则需n-1秒才能继续点赞
4、接口支持https
5、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

GET  POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
viewerId string 点赞观众的ID
times int 点赞的数目,不能超过30,提交后在times-1秒后才能再点赞

响应成功JSON示例:

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

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

未提交viewerID

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

点赞间隔小于1s

{
    "code": 400,
    "status": "error",
    "message": "您的操作过快,请稍后再试",
    "data": ""
}

点赞次数times大于30

{
    "code": 400,
    "status": "error",
    "message": "设置的次数过多,请稍后再试",
    "data": ""
}

字段说明

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

php请求示例

<?php

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

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

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

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

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

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

?>

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

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

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