后台单点登录

功能介绍

单点登录可以实现在登录已有系统的状态下,免登录操作进入保利威的账号、频道、子频道后台,做直播相关设置。

适用场景

保利威后台单点登录分:账号、频道、子频道三种。
账号:进入账号后台,获取最高的管理员权限,管理所有频道、子频道,适合机构管理员的登录跳转
频道:进入频道后台,仅获取当前频道的管理员权限,可管理当前频道及频道下的子频道,适合讲师的登录跳转
子频道:仅可进入助教页面,协助讲师在直播中管理聊天室、发起互动功能等,适合助教、助理的登录跳转

如何操作

1.操作流程图
sso
2.调用接口说明

操作类型 设置token接口(点击可查看详细接口调用) 单点登录后台接口
账号 https://api.polyv.net/live/v3/user/set-sso-token https://live.polyv.net/v2/sso/userLogin.do
频道 https://api.polyv.net/live/v2/channels/{channelId}/set-token https://live.polyv.net/teacher/auth-login
子频道 https://api.polyv.net/live/v2/channels/{accountId}/set-account-token https://live.polyv.net/teacher/auth-login

3.操作步骤

Step1.设置单点登录token参数

接口URL

1.根据操作类型(账号、频道、子频道)选择对应的设置token接口URL
    账号:https://api.polyv.net/live/v3/user/set-sso-token
    频道:https://api.polyv.net/live/v2/channels/{channelId}/set-token
    子频道:https://api.polyv.net/live/v2/channels/{accountId}/set-account-token
2.接口说明
    支持格式:JSON
    请求方式:GET,POST
    请求数限制:TRUE
    支持https协议
    接口URL中的{channelId}为 频道ID
    token 参数请勿过于简单,建议使用16位随机字符串

请求参数

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

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

Step2.成功设置token接口后,调用单点登录后台接口进行授权登录操作。

接口URL

1.根据操作类型(账号、频道、子频道)选择对应的单点登录后台接口URL
    账号:https://live.polyv.net/v2/sso/userLogin.do
    频道:https://live.polyv.net/teacher/auth-login
    子频道:https://live.polyv.net/teacher/auth-login
2.接口说明
    支持格式:JSON
    请求方式:GET
    请求数限制:TRUE
    支持https协议
    接口用于获取token后授权登录直播后台

操作类型为账号的请求参数

参数名 必选 类型 说明
userId string 账号id
token string 通过账号token设置的token串,10秒内且一次验证有效
redirect string 完成授权后重定向地址,使用url编码

操作类型为频道/子频道的请求参数

参数名 必选 类型 说明
channelId string 频道号或子频道号
token string 通过频道token子频道token设置的token串,10秒内且一次验证有效
redirect string 完成授权后重定向地址,使用url编码,如导播台统计分析

响应成功示例

1.账号:
有填写了redirect,并且验证成功则会重定向到相应的网页,否则返回错误
2.频道/子频道
有填写了redirect,并且验证成功则会重定向到相应的网页,否则默认重定向到相应的后台,验证失败则会重定向到频道登录页

请求示例

<?php
function settoken(){
//接口需要的参数
// 注意点:需替换的参数有:$appId、$appSecret、$channelId、$token(token是我们自己设置的)
$appId = "";
$appSecret = "";
$token = "2222222";
$timestamp=time()*1000;
$userId="";
$channelId="";
$nickname="王老师";

$params = array(
    'appId'=>$appId,
    'token'=>$token,
    'timestamp'=>$timestamp
  );
//计算sign
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));

//根据操作类型(账号、频道、子频道)设置对应的后台单点登录接口及定向地址。
$callbackUrl="https://live.polyv.net/teacher/auth-login?channelId=$channelId&token=$token&redirect=https://live.polyv.net/#/teacher/$channelId/chatReview/";

//根据操作类型(账号、频道、子频道)设置单点登录的token
$url="https://api.polyv.net/live/v2/channels/$channelId/set-token?appId=$appId&timestamp=$timestamp&token=$token&sign=$sign&nickname=";

//输出接口请求结果
$result=json_decode(file_get_contents($url),true);
if($result["code"] == 200){
    echo "location.href='" . $callbackUrl . "'";
 }
}

?>
<script language="JavaScript">
function bt_click(){
  <?php 
    settoken(); 
    ?>
}
</script>
<input type="button" name="show" id="show" value="提交" onClick="bt_click();"/>
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取直播用户账号信息接口

接口URL

https://api.polyv.net/live/v3/user/get-info

接口说明

1、接口用于用户账号信息接口
2、接口支持https

支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 管理员的appId
timestamp long 13位当前时间戳
sign string 签名值

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "userId": "xxxxx",
        "email": "xxxxxx@qq.com",
        "maxChannels": 500,
        "totalChannels": 252,
        "availableChannels": 248
    }
}

响应失败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 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data.userId 用户ID
data.email 邮箱账号
data.maxChannels 最大可创建频道数
data.totalChannels 当前已创建频道总数
data.availableChannels 当前剩余可创建频道数

请求示例

<?php

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

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

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

//接口请求url
$url = "http://api.polyv.net/live/v3/user/get-info?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/v3/user/category/update-rank

接口说明

1、修改账号下直播频道分类的顺序
2、接口支持https协议
3、默认分类不允许移动顺序

请求方式

POST

请求参数

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

响应成功JSON示例:

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

响应异常JSON示例:

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

字段说明

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

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'afterCategoryId' => 90,
  'categoryId' => 36
);

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

$url = "http://api.polyv.net/live/v3/user/category/update-rank?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

删除直播频道分类

接口URL

http://api.polyv.net/live/v3/user/category/delete

接口说明

1、删除账号下直播频道分类
2、接口支持https协议
3、默认分类不允许删除

请求方式

POST

请求参数

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

响应成功JSON示例:

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

响应异常JSON示例:

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

字段说明

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

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'categoryName' => '一级目录',
  'categoryId' => 36
);

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

$url = "http://api.polyv.net/live/v3/user/category/delete?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

修改直播频道分类名称

接口URL

http://api.polyv.net/live/v3/user/category/update-name

接口说明

1、修改账号下直播频道分类的名称
2、接口支持https协议
3、默认分类不允许修改名称

请求方式

POST

请求参数

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

响应成功JSON示例:

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

响应异常JSON示例:

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

字段说明

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

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'categoryName' => '一级目录',
  'categoryId' => 36
);

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

$url = "http://api.polyv.net/live/v3/user/category/update-name?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

设置密码

接口URL

https://api.polyv.net/live/v3/user/update-password

接口说明

设置密码

支持格式

JSON

请求方式

POST

请求参数

参数名 必选 类型及范围 说明
sign true string 签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
newPassword true string 新密码

返回错误结果JSON示例

签名错误:
{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
密码长度不正确:
{
    "code": 1113,
    "status": "error",
    "message": "param length is incorrect: newPassword",
    "data": ""
}

返回正确结果JSON示例

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

字段说明

字段 类型及范围 说明
code int32 返回码
status string 返回状态
message string 返回信息
data string 操作结果

PHP请求示例

<?php

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

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

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

$url = "https://api.polyv.net/live/v3/user/update-password?".http_build_query($params);

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

设置账号单点登录的token

接口URL

https://api.polyv.net/live/v3/user/set-sso-token

接口说明

该接口在单点登录后台使用场景中配合使用,点击查看具体单点登录文档

1、设置账号单点登陆的token
2、接口支持https协议
3、token 参数请勿过于简单,建议使用16位随机字符串
4、token设置后需要10秒内及时使用,使用请参考:

支持格式

JSON

请求方式

POST

请求参数

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

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

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

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

//接口请求url
$url = "https://api.polyv.net/live/v3/user/set-sso-token?appId=$appId&timestamp=$timestamp&token=$token&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/v3/user/category/create

接口说明

1、创建账号下直播分类
2、接口支持https协议

支持格式

JSON

请求方式

 POST

请求参数

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

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "categoryId": 185382,
        "categoryName": "888",
        "userId": "ee7fe7fbda",
        "rank": 2
    }
}

响应异常JSON示例:

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

字段说明

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

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'categoryName' => '一级目录',
);

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

$url = "http://api.polyv.net/live/v3/user/category/create?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 0);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

查询账号下所有频道详细信息

接口URL

http://api.polyv.net/live/v3/channel/management/list-detail

接口说明

1、获取账号下所有的频道详细信息列表
2、接口支持https协议

支持格式

JSON

请求方式

 POST

请求参数

参数名 必选 类型 说明
page int 页数默认为1
pageSize int 每页显示的数据条数,默认每页显示20条数据
appId string 从API设置中获取,在直播系统登记的appId
sign string 签名,为32位大写的MD5值
timestamp string 当前13位毫秒级时间戳,3分钟内有效
categoryId int 所属分类id
watchStatus string 观看页状态筛选,live-直播中,playback-回放中,end-已结束,waiting-未开始
keyword string 频道名称,模糊查询

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 20,
        "pageNumber": 1,
        "totalItems": 5,
        "contents": [{
            "channelId": 329298,
            "name": "Java课程",
            "channelPasswd": "123456",
            "categoryId": "177474",
            "scene": "topclass",
            "watchStatus": "waiting",
            "watchStatusText": "未开始",
            "sceneText": "大班课",
            "watchUrl": "https://live.polyv.cn/watch/329298",
            "content": "<p>开始了缴费解放路水电费;发送第三方数据fs</p><p><br></p><p><br></p><p><br></p><p>f伺服电机三方洛索洛芬</p>",
            "startTime": 0,
            "authSetting": [{
                "channelId": 329298,
                "rank": 1,
                "userId": "ee7fe7fbda",
                "globalSettingEnabled": "N",
                "enabled": "Y",
                "authType": "pay",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": null,
                "qcodeTips": null,
                "qcodeImg": null,
                "price": 0.10,
                "watchEndTime": null,
                "validTimePeriod": null,
                "customKey": "qydFTAaARY",
                "customUri": null,
                "externalKey": "qydFTAaARY",
                "externalUri": null,
                "externalRedirectUri": null,
                "directKey": null,
                "trialWatchEnabled": "N",
                "trialWatchTime": 1,
                "trialWatchEndTime": null
            }, {
                "channelId": 329298,
                "rank": 2,
                "userId": "ee7fe7fbda",
                "globalSettingEnabled": "N",
                "enabled": "N",
                "authType": "none",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": null,
                "qcodeTips": null,
                "qcodeImg": null,
                "price": 0.00,
                "watchEndTime": null,
                "validTimePeriod": null,
                "customKey": "qydFTAaARY",
                "customUri": null,
                "externalKey": "qydFTAaARY",
                "externalUri": null,
                "externalRedirectUri": null,
                "directKey": null,
                "trialWatchEnabled": "N",
                "trialWatchTime": null,
                "trialWatchEndTime": null
            }]
        }, {
            "channelId": 314392,
            "name": "云直播测试",
            "channelPasswd": "702036",
            "categoryId": "177474",
            "scene": "ppt",
            "watchStatus": "waiting",
            "watchStatusText": "未开始",
            "sceneText": "三分屏",
            "watchUrl": "https://live.polyv.cn/watch/314392",
            "content": "",
            "startTime": 0,
            "authSetting": [{
                "userId": "ee7fe7fbda",
                "rank": 1,
                "enabled": "N",
                "authType": "none",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": null,
                "qcodeTips": null,
                "qcodeImg": null,
                "price": 0.00,
                "watchEndTime": null,
                "validTimePeriod": null,
                "customKey": null,
                "customUri": null,
                "externalKey": null,
                "externalUri": null,
                "externalRedirectUri": null,
                "directKey": null,
                "trialWatchEnabled": "N",
                "trialWatchTime": null,
                "trialWatchEndTime": null
            }, {
                "userId": "ee7fe7fbda",
                "rank": 2,
                "enabled": "N",
                "authType": "none",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": null,
                "qcodeTips": null,
                "qcodeImg": null,
                "price": 0.00,
                "watchEndTime": null,
                "validTimePeriod": null,
                "customKey": null,
                "customUri": null,
                "externalKey": null,
                "externalUri": null,
                "externalRedirectUri": null,
                "directKey": null,
                "trialWatchEnabled": "N",
                "trialWatchTime": null,
                "trialWatchEndTime": null
            }]
        }],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "nextPageNumber": 1,
        "prePageNumber": 1,
        "limit": 2,
        "totalPages": 1,
        "endRow": 2,
        "offset": 0
    }
}

响应异常JSON示例:

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

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
pageNumber 当前页
totalItems 记录的总数
channelId 频道号
name 频道名称
channelPasswd 频道密码
categoryId 分类ID
scene 场景,alone-活动直播,ppt-三分屏,topclass-大班课
sceneText 场景描述
watchStatus 观看页状态,live-直播中,playback-回放中,end-已结束,waiting-未开始
watchStatusText 观看页状态描述,直播中,回放中,已结束,未开始
watchUrl 观看页链接
content 直播介绍
startTime 直播开始时间
userId 用户ID
rank 用于实现一个频道设置两个观看条件,为1或2(1为主要条件,2为次要条件)
globalSettingEnabled 是否开启全局设置(Y/N)
enabled 是否开启观看条件(Y/N)
authType 观看条件类型(1. 无限制 none 2. 验证码观看 code 3. 付费观看 pay 4. 白名单观看 phone 5. 登记观看 info 6. 分享观看 wxshare 7. 自定义授权观看 custom 8. 外部授权观看 external)
authTips 白名单观看提示信息
payAuthTips 付费观看提示信息
authCode 验证码观看的验证码
qcodeTips 验证码观看的二维码提示
qcodeImg 验证码观看的二维码图片
price 付费观看的价格
watchEndTime 付费观看,截止时间,为null表示:一次付费,永久有效
validTimePeriod 付费观看的截止时长 (天)
customKey 自定义授权观看的key
customUri 自定义授权观看的接口地址
externalKey 外部授权观看的key
externalUri 外部授权观看的接口地址
externalRedirectUri 外部授权观看,用户直接访问观看页时的跳转地址
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一条记录在总记录中的位置
endRow 当前页最后一个记录在总记录中的位置
limit 当前页纪录数
offset 当前页第一条记录在总记录中的位置

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'pageSize' => '5',
  'categoryId' => 89380
);

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

$url = "http://api.polyv.net/live/v3/channel/management/list-detail?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 0);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

设置功能开关状态

接口URL

https://api.polyv.net/live/v3/channel/switch/update

接口说明

1、接口用于修改功能开关设置,可修改全局开关设置或频道开关设置
2、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId int 频道号,不传该参数为获取全局设置
type string 开关类型
enabled string 开关值,Y或N

开关类型

type 描述
isClosePreview 是否关闭系统观看页,Y时表示关闭
mobileWatch 是否开启移动端系统观看页
mobileAudio 是否开启移动端音视频切换
autoPlay 是否开启播放器自动播放功能
booking 是否开启预约功能
redPack 是否开启红包功能
shareBtnEnabled 是否开启分享功能
chat 是否开启聊天室
closeChaterList 是否关闭在线列表,Y时表示关闭
consultingMenu 是否开启咨询提问
closeDanmu 是否关闭弹幕功能,Y时表示关闭
praise 是否开启点赞语功能
welcome 是否开启欢迎语功能
viewerSendImgEnabled 是否开启观众发送图片

注:isClosePreview当enabled值为Y时,表示的是关闭系统观看页;closeDanmu当enabled值为Y时,表示的是关闭弹幕;closeChaterList当enabled值为Y时,表示的是关闭在线列表

响应成功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": "param is not digit: dsadasd", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 修改成功过时为true

php请求示例

<?php
//引用config.php
include '/srv/http/config.php';

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => '206204',
  'type' => 'viewerSendImgEnabled',
  'enabled' => 'N'
);

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

$url = "http://api.polyv.net/live/v3/channel/switch/update?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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