直播基本信息设置(视频)

直播基本信息设置

在开始直播前,我们可以对直播的基本信息进行设置,设置项包括引导图、直播图标、直播名称、主持人名称、直播倒计时、观看人数、点赞人数;
1.上传的图标建议为140×140像素;
2.引导图建议为750×1334像素;
3.可以修改直播名称以及主持人的名称,完善直播信息;
4.预约功能默认是开启状态,设置直播开始时间后,手机端可以预约直播;
5.直播的累计观看人数和点赞人数也可以修改(归零或其它操作);
6.设置完毕后,点击保存。

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

删除频道聊天记录接口

接口URL

http://api.polyv.net/live/v2/chat/{channelId}/cleanChat

接口说明

1、接口用于删除频道所有聊天记录
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

响应成功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": 500, 
    "status": "fail", 
    "message": "api error.", 
    "data": ""
}

字段说明

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

php请求示例

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

$channelId="123713";

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

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


$url="http://api.polyv.net/live/v2/chat/".$channelId."/cleanChat";

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/chat/{channelId}/getQuestion

接口说明

1、接口用于获取咨询提问记录
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
begin int 起始下标,从0开始
end int 结束下标,-1表示不分页

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
        "id": "ee83ea70-43be-11e8-ad5a-cf5b830e2a70",
        "user": {
            "nick": "小明",
            "pic": "//livestatic.videocc.net/v_109/assets/wimages/missing_face.png",
            "userId": "1524134770059",
            "userType": "student"
        },
        "content": "十万个为什么",
        "time": 1524134795927
    }, {
        "id": "ebb27af0-43be-11e8-ad5a-cf5b830e2a70",
        "user": {
            "nick": "小明",
            "pic": "//livestatic.videocc.net/v_109/assets/wimages/missing_face.png",
            "userId": "1524134770059",
            "userType": "student"
        },
        "content": "咨询提问问题1",
        "time": 1524134791199
    }]
}

响应失败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": 500, 
    "status": "fail", 
    "message": "api error.", 
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200 错误为400,签名错误为403,接口错误为500
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空串,错误时错误信息
data 请求成功为数据内容,错误为空串
id 信息id
content 内容
time 时间,13位时间戳
nick 发言人昵称
userId 发言人ID
userType 发言人类型值

php请求示例

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

$channelId="183950";

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

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

$url = "http://api.polyv.net/live/v2/chat/".$channelId."/getQuestion?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/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...

自定义授权

一、功能路径

我的直播 --> 频道设置-->观看条件设置-->自定义授权

二、功能介绍

打开直播观看页时,直播系统会调用客户系统的验证接口,客户自定义验证逻辑,验证通过后才能打开保利威视直播观看页,并且接口返回的观众账号具有唯一性,即同一个账号不能在两个地方同时登录,较早登录的账号会被踢出。
customAuth

  1. Secretkey:用于校验签名的生成。
  2. 自定义URL:用于自定义授权验证的API接口。

三、自定义授权流程详解

  1. 在自定义URL处填写用户的授权验证API接口,需要完整的不带参数的url地址(不能是localhost等本地服务器地址,且不能带 ? 号),如:http://myWebsite.com/auth。
  2. 直播系统会将id(直播的频道)、ts(当前时间的毫秒级时间戳)、sign(用于校验的签名)、url(回调的url地址)等参数提交给用户自定义的API接口,用户需要对字符串secretkey + id + secretkey + ts进行MD5加密后与sign参数的值做比较判断是否合法。
  3. 通过校验和自定义验证逻辑后,客户系统将userid(学员唯一标识)、nickname(昵称)、avatar(头像)、ts(当前时间的毫秒级时间戳)、sign(校验签名)等参数提交到回调的url接口。
  4. 直播系统会对签名做校验后判断是否允许学员观看.校验通过后将进入直播观看页,聊天区域将显示观众的昵称和头像。一次成功请求后,该链接将失效。

流程图如下

自定义授权流程图

四、参数说明

自定义授权观看参数说明

五、代码示例(PHP)

<?php
$secretkey = "jlw42byyJ6"; //后台secretKey,在自定义授权地址设置页面
$id        = $_GET["id"]; //直播的频道id
$ts        = $_GET["ts"]; //当前时间
$sign      = $_GET["sign"]; //用于检验的签名
$url       = $_GET["url"]; //回调的url
$md5       = md5($secretkey . $id . $secretkey . $ts); //若md5字符串与sign不符合,则不做任何处理
if (!($sign == $md5)) {
    return;
}
$userid       = "eciyhturt8"; //学员唯一标识
$nickname     = urlencode(base64_encode("保利威视")); //学员的昵称
$avatar       = "http://live.polyv.net/assets/images/avatars/9avatar.jpg"; //学员的头像
$callbackTs   = time() * 1000; //当前的系统时间
$callbackSign = md5($secretkey . $id . $secretkey . $callbackTs . $secretkey . $userid); //用于检验的签名
$callbackUrl  = $url . "?userid=" . $userid . "&nickname=" . $nickname . "&avatar=" . $avatar . "&ts=" . $callbackTs . "&sign=" . $callbackSign; //新的直播页面url
//打开新的直播页面url
echo "<script language='javascript' type='text/javascript'>location.href='" . $callbackUrl . "'</script>"
?>

六、展示效果

http://live.polyv.cn/watch/104400

七、注意事项

  1. .要保证自定义验证接口返回的userid的唯一性,当多个观众使用同一个userid进入观看页时,较早登录的观众会被后面登录的观众踢出,观看页会提示 "帐号在另外的地方登录,您将被退出观看。"如下图:
    退出观看提示

  2. 学员的昵称进行base64加密后再进行urlencode加密,否则可能会造成观看页昵称显示乱码现象。

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

通用设置

一.功能途径

云直播-->通用设置

通用设置1

二.功能介绍

  • 通用设置内功能,对账号内所有频道生效
  • 通用设置中的功能有:
    • 通用设置:聊天室严禁词
    • 默认值设置:观看条件、打赏设置、广告设置、防录屏跑马灯

注意:1.聊天室严禁词:对所有频道生效、与单个频道设置里面的严禁词设置属于并存的关系

2.观看条件、打赏设置、广告设置、防录屏跑马灯:新建的频道在新建时,以上功能为默认值设置的内容,而已设置过的频道则频道设置的优先级最高,即默认值设置的内容与频道设置的只能二选一

通用设置2

三.使用步骤

由于通用设置里的功能与频道设置中对应的功能使用逻辑一样,此处不赘述

  • 聊天室严禁词
  • 观看条件
    • 付费观看
    • 白名单观看
    • 登记观看
    • 验证码观看
    • 自定义授权
    • 外部授权
    • 分享观看
  • 打赏设置
  • 广告设置
  • 防录屏跑马灯
  • 功能开关
  • 播放限制
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

外部授权

一、功能路径

我的直播 --> 频道设置-->观看条件设置-->外部授权

二、功能介绍

打开直播观看页的时候URL需带上指定的参数,经过直播系统验证请求合法后,直播系统会调用客户在后台设置的自定义授权验证接口,进行外部授权验证,两次验证通过,才能进入直播观看页,并且接口返回的观众账号具有唯一性,即同一个账号不能在两个地方同时登录,较早登录的账号会被踢出。
externalAuth1

  1. Secretkey:用于校验签名的生成。
  2. 自定义URL:用于外部授权验证的API接口。
  3. 跳转地址:观众直接访问Polyv观看页,会跳转到该地址;若跳转地址为空,则显示默认提示页。

三、外部授权流程详解

  1. 在自定义URL处填写用户的授权验证API接口,需要完整的不带参数的url地址(不能是localhost等本地服务器地址,且不能带 ? 号),如:http://myWebsite.com/auth。
  2. 在请求保利威视直播观看页时需带上userid(用户ID)、ts(当前时间的毫秒级时间戳)和sign(用于校验的签名,生成规则是secretkey + userid + secretkey + ts进行MD5加密),如https://live.polyv.cn/watch/125527?userid=6b3a43&ts=1498547407000&sign=dd9dc9e42ad7c0204398e925a4ee0f46
  3. 直播系统会对字符串secretkey+userid+secretkey+ts进行MD5加密后与用户提交的sign参数的值做比较判断是否合法。一次成功请求后,该链接将失效(sign只能成功使用一次)。如果合法,直播系统将调用用户的api接口,并把userid(用户ID)、ts(当前时间的毫秒级时间戳)和token(用于校验的签名)三个参数传给用户。如果不合法,则给出错误提示。
  4. 用户API接口获取userid、ts和token参数后,进行外部授权验证。如果验证通过,则将status(返回状态)、userid(学员唯一标识)、nickname(学员昵称)、avatar(学员头像)等参数以json格式返回给直播系统。如果验证不通过,则将status(返回状态)、errorUrl(用户自定义错误页面)等参数返回给直播系统。
  5. 直播系统接收用户API接口返回的数据,如果验证成功,则进入到保利威视直播观看页,聊天区将显示学员的昵称和头像。如果验证失败,则给出错误提示。

流程图如下

外部授权流程图

四、参数说明

外部授权参数

五、代码示例(PHP)

<?php
header("Content-type:application/json;charset=UTF-8"); //媒体格式类型为JSON数据格式
$secretkey = "aDrOt0Cpy8";
$userid    = isset($_GET["userid"]) ? $_GET["userid"] : "";
$ts        = isset($_GET["ts"]) ? $_GET["ts"] : "";
$token     = isset($_GET["token"]) ? $_GET["token"] : "";
$sign      = md5($secretkey . $userid . $secretkey . $ts);

//用户进行授权验证,返回对应的数据(json格式)
if ($sign == $token) {
    //验证正确
    $array1 = array(
        "status"   => 1, //返回状态
        "userid"   => $userid, //学员唯一标识
        "nickname" => "保利威视", //学员昵称
        "avatar"   => "http://live.polyv.net/assets/images/avatars/9avatar.jpg", //学员头像
    );
    $json1 = json_encode($array1);
    echo $json1;
} else {
    //验证错误
    $array0 = array(
        "status"   => 0,
        "errorUrl" => "http://xxx.xx.xxxx/error.html", //验证错误跳转的自定义页面
    );
    $json0 = json_encode($array0);
    echo $json0;
}

六、展示效果

http://demo.polyv.net/chenwb/open.php

七、注意事项

  1. .要保证自定义验证接口返回的userid的唯一性,当多个观众使用同一个userid进入观看页时,较早登录的观众会被后面登录的观众踢出,观看页会提示 "帐号在另外的地方登录,您将被退出观看。"如下图:
    被踢

  2. 自定义验证接口需要填写完整的URL地址,且不能是localhost等本地服务器地址。

  3. 自定义验证接口返回给直播系统的数据格式是json格式。

八、错误提示

  1. user not found:请求自定义验证接口错误,或者接口返回的格式不对。
  2. invalid sign:签名错误,sign的生成规则是secretkey+userid+secretkey+ts进行MD5加密。
  3. sign expired:签名过期,每一个sign只能使用一次,使用后需重新生成。
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

数据统计

一.功能途径

云直播-->统计分析-->数据统计

数据统计1

二.功能介绍

  • 数据统计是以频道号为对象进行的数据统计
  • 数据统计分为:频道汇总、日期汇总、地域分布、观看终端、最高在线人数
    • 频道汇总:以频道号为单位统计不同时间段的数据情况
    • 日期汇总:以日期为单位统计一天的观看数据
    • 地域分布:统计不同时间段观看的地域分布,分中国地区已经全球分布
    • 观看终端:统计不同时间的段观看终端,分PC端和移动端
    • 最高在线人数:统计不同时间段的最高在线人数

数据统计2

三.使用步骤

1.频道汇总: -

  • 点击时间选择区域可查看不同时间段的频道号
  • 可导出数据
  • 点击查看详情可跳转至单个频道的统计分析界面

数据统计4

2.日期汇总 -

  • 可选择列表或图表
  • 可选择不同的时间段
  • 可导出数据

效果图如下

日期汇总日期汇总图表

3.地域分布 -

  • 可选择不同地区:中国地区、全球分布
  • 可选择不同时间段
  • 可导出数据

效果图如下

地域分布

4.观看终端 -

  • 分PC段和移动端
  • 可选择时间段
  • 可导出数据

效果图如下
观看终端

5.最高在线人数 -

  • 可选择时间段
  • 可导出数据
  • 可对单个频道进行查看

效果图如下

最高在线人数2

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

播放器嵌入

一、功能路径

我的直播 --> 频道设置-->播放器嵌入

二、功能介绍

您可以通过嵌入Polyv直播播放器代码的方式,在自己网站页面播放直播。
embedded
- 嵌入代码可用于PC端和移动端页面。
- 您还可以通过播放器提供的接口进行播放器控制栏和弹幕的更多控制,详情请参考页面提供的文档链接。

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