获取账号下回放视频

接口URL

https://api.polyv.net/live/v3/user/playback/list

接口说明

(接口调用有频率限制,详细请查看)

1、接口用于获取账号下回放列表和点播列表, 注意:不包括括暂存列表
2、接口支持https

返回结果格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
page string 页码,默认为1
pageSize string 每页条数,默认为20,合法范围为1-1000
order string 排序规则,取值:timeDesc(按createdTime降序)、rankDesc(按rank降序)、time(按createdTime升序)、rank(按rank升序),默认是timeDesc
listType string playback-回放列表,vod-点播列表,默认是playback

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 100,
        "pageNumber": 1,
        "totalItems": 3,
        "contents": [
            {
                "videoId": "88c40acaa6",
                "videoPoolId": "a2dc4f2517fd872d6b2a4b1e470a91cb_a",
                "userId": "a2dc4f2517",
                "channelId": 1234567,
                "title": "保利威",
                "firstImage": "http://img.videocc.net/uimage/a/a2dc4f2517/b/a2dc4f2517fd872d6b2a4b1e470a91cb_0.jpg",
                "duration": "00:00:56",
                "myBr": "1",
                "qid": null,
                "seed": 0,
                "ordertime": 0,
                "createdTime": 1592040864000,
                "lastModified": 1592040864000,
                "rank": 2,
                "asDefault": "N",
                "url": "https://hls.videocc.net/source/a2dc4f2517/b/a2dc4f2517fd872d6b2a4b1e470a91cb_1.m3u8",
                "channelSessionId": "fo76et1ftb",
                "status": "Y",
                "fileId": "d2c55e369aad1fd5f732141cb4779f4a",
                "startTime": "20200609100810",
                "liveType": "alone",
                "errorCount": null,
                "mergeinfo": "[\"20200609100810,56,fo76et1ftb\"]",
                "watchUrl": "//live.polyv.cn/watch/1762629?vid=88c40acaa6"
            },
            {
                "videoId": "c70649db67",
                "videoPoolId": "a2dc4f25177fc4fcb389e871b2d5ee04_a",
                "userId": "a2dc4f2517",
                "channelId": 1810121,
                "title": "保利威",
                "firstImage": "http://img.videocc.net/uimage/a/a2dc4f2517/4/a2dc4f25177fc4fcb389e871b2d5ee04_0.jpg",
                "duration": "00:01:08",
                "myBr": "1",
                "qid": null,
                "seed": 0,
                "ordertime": 0,
                "createdTime": 1593417163000,
                "lastModified": 1593417163000,
                "rank": 1,
                "asDefault": "N",
                "url": "https://hls.videocc.net/source/a2dc4f2517/4/a2dc4f25177fc4fcb389e871b2d5ee04_1.m3u8",
                "channelSessionId": "fothpt2mpv",
                "status": "Y",
                "fileId": "5db4c890929c4aa71503e7ef2615c6c3",
                "startTime": "20200629153802",
                "liveType": "alone",
                "mergeinfo": null,
                "watchUrl": "//live.polyv.cn/watch/1810121?vid=c70649db67"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "prePageNumber": 1,
        "totalPages": 1,
        "endRow": 3,
        "nextPageNumber": 1,
        "limit": 3,
        "offset": 0
    }
}

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

pageSize范围错误,合法值为1-1000

{
    "code": 403,
    "status": "error",
    "message": "number range error",
    "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
data 响应结果
message 异常错误信息
videoId 直播系统生成的id
videoPoolId 点播视频vid
userId 点播后台用户id
channelId 回放视频对应的直播频道id
title 视频标题
firstImage 视频首图
duration 视频长度
myBr 默认视频的播放清晰度,1为流畅,2为高清,3为超清
qid 访客信息收集id
seed 视频加密状态,1表示为加密状态,0为非加密
createdTime 添加为回放视频的日期
lastModified 视频最后修改日期
rank 排序值,值越大优先级越高
asDefault 是否为默认播放视频,值为Y/N
url 视频播放地址,注:如果视频为加密视频,则此地址无法访问
channelSessionId 用于PPT请求数据,与PPT直播的回放相关,普通直播回放值为null
mergeInfo 视频合并信息
startTime 直播开始时间
watchUrl 观看回放视频的地址
data.status 只返回状态为Y的视频
pageNumber 视频列表页数(默认以20条数据为1页)
totalItems 回放视频总个数
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一个视频在回放视频中的位置
endRow 当前页最后一个视频在回放视频中的位置
limit 当前页视频个数

Java请求示例

public void test() {
        String url = "https://api.polyv.net/live/v3/user/playback/list";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("order", "timeDesc");
        params.put("listType", "playback");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/

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

获取全账号频道基础信息接口

接口URL

https://api.polyv.net/live/v3/channel/basic/list

接口说明

(接口调用有频率限制,详细请查看)

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

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位的MD5值大写
page int 查询页数,默认1
pageSize int 每页大小,默认20,最大20

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 3,
        "contents": [
            {
                "channelId": 1907006,
                "name": "状态",
                "publisher": "主持人",
                "startTime": 1599753600000,
                "pageView": 57,
                "likes": 11,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": null,
                "splashEnabled": "N",
                "desc": "",
                "maxViewer": -1,
                "watchStatus": "waiting",
                "watchStatusText": "未开始",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": null
            },
            {
                "channelId": 1885180,
                "name": "122",
                "publisher": "主持人",
                "startTime": 0,
                "pageView": 16,
                "likes": 0,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": null,
                "splashEnabled": "N",
                "desc": "",
                "maxViewer": -1,
                "watchStatus": "playback",
                "watchStatusText": "回放中",
                "onlineNum": 0,
                "bgImg": "https://liveimages.videocc.net/uploaded/images/2020/09/fqu9liyyvs.jpg",
                "videoList": [
                    {
                        "videoId": "71b8884882",
                        "videoPoolId": "cf7f07e0967096c90bb16c0c3c887603_c"
                    }
                ]
            },
            {
                "channelId": 1882911,
                "name": "biny-test",
                "publisher": "主持人",
                "startTime": 0,
                "pageView": 9,
                "likes": 1,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": null,
                "splashEnabled": "N",
                "desc": "",
                "maxViewer": -1,
                "watchStatus": "end",
                "watchStatusText": "已结束",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": null
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "prePageNumber": 1,
        "limit": 3,
        "totalPages": 1,
        "endRow": 3,
        "nextPageNumber": 1,
        "offset": 0
    }
}

响应失败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 int 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data Page 响应结果集

Page对象

参数名 类型 说明
pageNumber int 列表页数
totalItems int 总数
contents List 频道的详细信息列表,无数据时为空,参考Detail对象

Detail对象

参数名 类型 说明
channelId int 频道号
name string 频道名称
publisher string 主持人名称
startTime long 直播开始时间,关闭时为0,开启时为13位毫秒级时间戳
pageView int 页面累计观看数
likes int 观看页点赞数
coverImg string 频道图标url
splashImg string 频道引导图url
splashEnabled string 引导页开关,取值为: Y/N
desc string 直播介绍
maxViewer int 最大在线观看人数
watchStatus string 频道的观看页状态,取值为: 频道状态,取值:live(直播中)、end(直播结束)、playback(回放中)、waiting(等待直播)
watchStatusDesc string 观看页状态描述,直播中,回放中,已结束,未开始
onlineNum int 在线人数
bgImg string 暖场图片URL
videoList List 回放视频列表,当有多个时按添加时间倒叙排列;参考Video对象

Video对象

参数名 类型 说明
videoId string 直播系统生成的id (视频库中的回放视频)
videoPoolId string 点播视频vid (视频库中的回放视频)

Java请求示例

public static void testGetUserRealTimeConcurrence() {
        String url = "https://api.polyv.net/live/v3/channel/basic/list";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/

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

获取账号连麦分钟数使用量与剩余量

接口URL

http://api.polyv.net/live/v3/channel/statistics/mic/get-duration

接口说明

(接口调用有频率限制,详细请查看)

1、获取账号连麦使用情况
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "available": -279,
        "history": 279
    }
}

响应失败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 int 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data object 响应结果集
available int 可用连麦分钟数,单位分钟
history int 历史已使用连麦分钟数,单位分钟

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/statistics/mic/get-duration";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/

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

后台单点登录

功能介绍

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

适用场景

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

如何操作

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编码,如导播台统计分析 或 网页开播:https://live.polyv.net/web-start/?channelId={频道号}

响应成功示例

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));


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

//根据操作类型(账号、频道、子频道)设置单点登录的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...

设置账号单点登录的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...