修改密码接口

接口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": ""
}

返回结果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/channel/document/delete?".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...

查询功能开关状态接口

接口URL

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

接口说明

1、接口用于获取开关设置,可获取全局开关设置或频道开关设置
2、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
  "code": 200, 
  "status": "success", 
  "message": "", 
  "data": [
    {
      "type": "isClosePreview", 
      "enabled": "N"
    }, 
    {
      "type": "mobileWatch", 
      "enabled": "Y"
    }, 
    {
      "type": "mobileAudio", 
      "enabled": "Y"
    }, 
    {
      "type": "autoPlay", 
      "enabled": "Y"
    }, 
    {
      "type": "booking", 
      "enabled": "Y"
    }, 
    {
      "type": "redPack", 
      "enabled": "Y"
    }, 
    {
      "type": "shareBtnEnabled", 
      "enabled": "Y"
    }, 
    {
      "type": "chat", 
      "enabled": "Y"
    }, 
    {
      "type": "closeChaterList", 
      "enabled": "N"
    }, 
    {
      "type": "consultingMenu", 
      "enabled": "Y"
    }, 
    {
      "type": "closeDanmu", 
      "enabled": "N"
    }, 
    {
      "type": "praise", 
      "enabled": "Y"
    }, 
    {
      "type": "welcome", 
      "enabled": "Y"
    }, 
    {
      "type": "chatPlayBack", 
      "enabled": "Y"
    }, 
    {
      "type": "viewerSendImgEnabled", 
      "enabled": "Y"
    }
  ]
}

响应失败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 成功响应时为当前开关设置项
type 开关类型
enabled 是否已打开开关

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

php请求示例

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

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

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

$url = "http://api.polyv.net/live/v3/channel/switch/get?".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...

查询账号下直播分类

接口URL

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

接口说明

1、获取账号下所有的直播分类信息
2、接口支持https协议

支持格式

JSON

请求方式

 GET,POST

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "categoryId": 2034,
            "categoryName": "默认分类",
            "userId": "edvf2fpec9",
            "rank": 0
        },
        {
            "categoryId": 36,
            "categoryName": "测试测试测试",
            "userId": "edvf2fpec9",
            "rank": 1
        }
    ]
}

响应异常JSON示例:

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

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
categoryId 分类ID
categoryName 分类名称
userId 用户ID
rank 分类排序号,rank=0表示为默认排序

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$timestamp = 1528708015437;
$appId = "test";

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

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
//接口请求url
$url = "http://api.polyv.net/live/v3/user/category/list?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/v3/channel/management/list

接口说明

1、获取账号下所有的频道简单信息列表
2、列表信息仅包含频道简单信息,如需频道具体信息,请使用【获取频道信息】接口
3、接口支持https协议

支持格式

JSON

请求方式

 GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
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": 5, 
        "pageNumber": 1, 
        "totalItems": 18, 
        "contents": [
            {
                "channelId": 324322, 
                "name": "t1", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "topclass", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "大班课", 
                "watchUrl": "https://live.polyv.cn/watch/324322"
            }, 
            {
                "channelId": 323876, 
                "name": "ffff", 
                "channelPasswd": "333", 
                "categoryId": "182162", 
                "scene": "alone", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/323876"
            }, 
            {
                "channelId": 269428, 
                "name": "rrr", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "alone", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/269428"
            }, 
            {
                "channelId": 244314, 
                "name": "tttt", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "alone", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/244314"
            }, 
            {
                "channelId": 221626, 
                "name": "tttttt", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "alone", 
                "watchStatus": "live", 
                "watchStatusText": "直播中", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/221626"
            }
        ], 
        "startRow": 1, 
        "firstPage": true, 
        "lastPage": false, 
        "nextPageNumber": 2, 
        "prePageNumber": 1, 
        "limit": 5, 
        "endRow": 5, 
        "totalPages": 4, 
        "offset": 0
    }
}

响应异常JSON示例:

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

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
pageNumber 当前页
totalItems 记录的总数
channelId 频道号
name 频道名称
channelPasswd 频道密码
scene 场景,alone-活动直播,ppt-三分屏,topclass-大班课
sceneText 场景描述
watchStatus 观看页状态,live-直播中,playback-回放中,end-已结束,waiting-未开始
watchStatus 观看页状态描述,直播中,回放中,已结束,未开始
watchUrl 观看页链接
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?".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

接口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

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