获取用户实时并发接口

接口URL

https://api.polyv.net/live/v3/user/statistics/realtime-concurrence

接口说明

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

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": 100
}

响应失败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 响应结果集 ,用户的实时并发数,整型

Java请求示例

public static void testGetUserRealTimeConcurrence() {
        String url = "https://api.polyv.net/live/v3/user/statistics/realtime-concurrence";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, 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/questionnaire/list-mc

接口说明

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

1、接口用于获取多个频道的问卷列表,包括改已经提交数量
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelIds string 频道号, 多个频道用英文逗号,隔开
startTime long 查询的记录的开始时间,13位位毫秒级时间戳
endTime long 查询的记录的结束时间,13位毫秒级时间戳
page int 页号,默认为1
pageSize int 每页条数,默认为10

注意:要按时间区间查询时,startTime 和 endTime 必须同时传参才能生效

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 2,
        "contents": [
            {
                "questionnaireId": "fefg598lfj",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "测试问卷_1564105496583",
                "status": "forbidden",
                "createdTime": 1564105498000,
                "lastModified": 1564105498000,
                "endTime": 1564105580000,
                "customQuestionnaireId": "xxxxxx",
                "submitCount": 123
            },
            {
                "questionnaireId": "fefg4s724k",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "测试问卷",
                "status": "forbidden",
                "createdTime": 1564105469000,
                "lastModified": 1564105469000,
                "endTime": 1564105487000,
                "customQuestionnaireId": "xxxxxx",
                "submitCount": 123
            },
            ,
            {
                "questionnaireId": "fefg4s724j",
                "channelId": 108887,
                "userId": "edvf2fpec9",
                "name": "测试问卷3",
                "status": "forbidden",
                "createdTime": 1564105469000,
                "lastModified": 1564105469000,
                "endTime": 1564105487000,
                "customQuestionnaireId": "xxxxxx",
                "submitCount": 123
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "nextPageNumber": 1,
        "prePageNumber": 1,
        "limit": 2,
        "endRow": 2,
        "totalPages": 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 响应的状态码,例如:200
status 响应状态
message 异常错误信息
data 响应结果集
pageNumber 当前的页数
totalItems 总的条数
contents 查询的结果列表
questionnaireId 问卷ID
channelId 频道ID
userId 用户ID
name 问卷名称
status 问卷状态,取值:saved(已保存),published (已发布),forbidden (问卷已完成填写)
createdTime 问卷创建时间
lastModified 问卷最后修改时间
endTime 停止提交问卷时间
customQuestionnaireId 用户自定义问卷ID
submitCount 问卷提交数量
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一个视频在回放视频中的位置
endRow 当前页最后一个视频在回放视频中的位置
limit 当前页视频个数

php请求示例

<?php
//引用config.php
include 'config.php';
$params = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'channelIds' => "108888"
);

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

$url = "https://api.polyv.net/live/v3/channel/questionnaire/list-mc?".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/channel/management/query-list-sample

接口说明

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

1、分页获取简单频道列表信息接口
2、每页数据最大100个
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelIds string 频道号,多个以英文逗号分割开,如:100001,100002
startDay string 开始日期,格式yyyy-MM-dd
endDay string 结束日期,格式yyyy-MM-dd
size int 每页大小
page int 当前页

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 1,
        "pageNumber": 1,
        "totalItems": 129,
        "contents": [
            {
                "channelId": 128457,
                "name": "普通暖场视频",
                "startTime": "2020-08-06 18:20:00.0"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": false,
        "prePageNumber": 1,
        "limit": 1,
        "endRow": 1,
        "nextPageNumber": 2,
        "totalPages": 129,
        "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 object 响应结果集
pageNumber int 当前的页数
totalItems int 总的条数
contents array 查询的结果列表
channelId int 频道号
name string 频道名称
startTime string 直播开始时间
firstPage boolean 是否为第一页,值为:true/false
lastPage boolean 是否为最后一页,值为:true/false
nextPageNumber int 下一页编号
prePageNumber int 上一页编号
totalPages int 总页数
startRow int 当前页第一个数量的位置
endRow int 当前页最后一个数量的位置
limit int 每页数量大小

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/management/query-list-sample";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelIds", "0000000");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, 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/user/statistics/viewlog-with-checkin

接口说明

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

1、作用:分页获取频道带有学员签到信息的观看日志
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
channelId int 频道ID
timestamp string 当前13位毫秒级时间戳,3分钟内有效
page string 页数
pageSize string 每页显示的数据条数,默认每页显示1000条数据
currentDay 请查看下方注意点 string 查询日期,格式:yyyy-MM-dd
startTime 请查看下方注意点 string 查询开始时间,为13位毫秒级时间戳
endTime 请查看下方注意点 string 查询结束时间,13位毫秒级时间戳
param1 string 观看用户ID
param2 string 观看用户昵称
param3 string 观看日志类型
sign string 签名,32位大写MD5值

注意
1. 如果查询一段时间的记录,可以传:startTime、endTime (startTime和endTime 必须在同一个月),如果查询某天的记录,则传currentDay;
2. startTime、endTime 和 currentDay不能都不传;
3. currentDay与startTime、endTime 同时传将使用currentDay的值。

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": {
        "pageNumber": 1, 
        "totalItems": 3, 
        "contents": [
            {
            "playId": "1520501687122X1438160",
            "userId": "1c6dc3c666",
            "channelId": 151462,
            "playDuration": 341,
            "stayDuration": 361,
            "flowSize": 10028116,
            "sessionId": "eyz0awxrlh",
            "param1": "1520499775580",
            "param2": "广州观众/78614",
            "param3": "live",
            "param4": "",
            "param5": "",
            "ipAddress": "59.42.41.1",
            "country": "中国",
            "province": "广东",
            "city": "广州",
            "isp": "/南沙区电信",
            "referer": "https://live.polyv.cn/watch/151462",
            "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
            "operatingSystem": "Mac OS X",
            "browser": "Chrome",
            "isMobile": "N",
            "currentDay": "2018-03-08",
            "createdTime": 1520501705000,
            "lastModified": 1520504494000,
            "leftTime":1520507705000,
            "firstTime": null,
            "lastTime": null,
            "num": 0
            }, 
            {
            "playId": "1520501157256X1429802",
            "userId": "1c6dc3c666",
            "channelId": 151462,
            "playDuration": 29,
            "stayDuration": 528,
            "flowSize": 1068201,
            "sessionId": "eyz0awxrlh",
            "param1": "1520499775580",
            "param2": "广州观众/78614",
            "param3": "live",
            "param4": "",
            "param5": "",
            "ipAddress": "59.42.41.1",
            "country": "中国",
            "province": "广东",
            "city": "广州",
            "isp": "/南沙区电信",
            "referer": "https://live.polyv.cn/watch/151462",
            "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
            "operatingSystem": "Mac OS X",
            "browser": "Chrome",
            "isMobile": "N",
            "currentDay": "2018-03-08",
            "createdTime": 1520501664000,
            "lastModified": 1520504494000,
            "leftTime":1520507705000,
            "firstTime": null,
            "lastTime": null,
            "num": 0
            }, 
                        {
            "playId": "1520500551108X1714565",
            "userId": "1c6dc3c666",
            "channelId": 151462,
            "playDuration": 18,
            "stayDuration": 20,
            "flowSize": 3048444,
            "sessionId": "eyz0awxrlh",
            "param1": "1520499775580",
            "param2": "广州观众/78614",
            "param3": "live",
            "param4": "",
            "param5": "",
            "ipAddress": "59.42.40.205",
            "country": "中国",
            "province": "广东",
            "city": "广州",
            "isp": "/南沙区电信",
            "referer": "https://live.polyv.cn/watch/151462",
            "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
            "operatingSystem": "Mac OS X",
            "browser": "Chrome",
            "isMobile": "N",
            "currentDay": "2018-03-08",
            "createdTime": 1520500572000,
            "lastModified": 1520503294000,
            "firstTime": 1520501234000,
            "lastTime": 1520505678000,
            "num": 3
            }
        ], 
        "endRow": 3, 
        "startRow": 1, 
        "firstPage": true, 
        "lastPage": true, 
        "nextPageNumber": 1, 
        "prePageNumber": 1, 
        "totalPages": 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": ""
}

未输入currentDay

{
    "code": 400,
    "status": "error",
    "message": "currentDay is empty.",
    "data": ""
}

频道不存在

{
    "code": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

非法的频道ID

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

字段说明

参数名 说明
code 响应的状态码,例如:200
status 响应状态
message 异常错误信息
data 响应结果集
pageNumber 当前的页数
totalItems 总的条数
contents 查询的结果列表
playId 表示此次播放动作的ID
userId 用户ID
channelId 频道号
playDuration 播放时长
stayDuration 缓存时长
flowSize 流量大小
sessionId 直播场次ID
param1 使用POLYV观看页的观众ID
param2 使用POLYV观看页的观众昵称
param3 观看类型:取值 live(直播)、vod(回放)
param4/5 POLYV系统参数
ipAddress IP地址
country 国家
province 省份
city 城市
isp ISP运营商
referer 播放视频页面地址
userAgent 用户设备
operatingSystem 操作系统
browser 浏览器
isMobile 是否为移动端
currentDay 日志查询日期 (格式为:yyyy-MM-dd)
createdTime 日志创建日期 (13位时间戳)
lastModified 日志更新日期 (13位时间戳)
leftTime 离开直播时间 (13位时间戳)
firsTime 该场直播中首次签到时间 (13位时间戳),没有签到信息时返回为null
lastTime 该场直播中最后一次签到的时间(13位时间戳),没有签到信息时返回为null
num 该场直播的签到次数,没有签到信息返回为0
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一个记录在列表中的位置
endRow 当前页最后一个记录在列表中的位置
limit 当前页记录个数

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "124545";
$currentDay = "2018-03-12";  
$page = "1"; //页数
$pageSize="10";//每页显示的数据

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

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

//接口请求url
$url = "http://api.polyv.net/live/v3/channel/statistics/viewlog-with-checkin?appId=$appId&channelId=$channelId&currentDay=$currentDay&page=$page&pageSize=$pageSize&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/chat/content/create-task

接口说明

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

1、异步下载聊天室聊天记录接口
2、如果异步下载成功,返回下载地址,下载地址有效期一天
2、接口支持https

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
       "status": "done",
       "url": "https://doc-oss.polyv.net/chat/export/xls/130760/130760_1597804097778.xls",
       "lastExportTime": 1597804097778
    }
}

响应失败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 响应结果集
status string 异步下载状态todo:待下载done:已完成doing:下载中
url string 下载地址
lastExportTime long 最后一次下载的时间,单位:毫秒

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/chat/content/create-task";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, 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/statistics/geo-summary-mc

接口说明

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

1、接口用于获取多个频道下(聚合查询结果)的地域分布信息
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelIds string 频道号,多个频道以,隔开
startDate string 开始日期格式,yyyy-MM-dd
endDate string 结束日期格式,yyyy-MM-dd
global string 是否查询按国家统计,Y 按国家统计,N 按国内省份统计,默认是N
city string 是否按城市统计, Y:按城市统计,N:按省份统计,在global=N 时才生效,默认是N

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "province": "广东",
            "city": "广州",
            "viewer": 1,
            "percent": 100.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": 403, 
  "status": "error", 
  "message": "illegal channel id: 1234567", 
  "data": ""
}

频道号格式错误

{
  "code": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

日期范围错误

{
  "code": 400, 
  "status": "error", 
  "message": "startDate can not great endDater", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 多个频道下(聚合查询结果)的地域分布信息
data[0].province 省份
data[0].city 城市,如果按省份统计,则该字段为空
data[0].viewer 人数
data[0].percent 百分比

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/statistics/geo-summary-mc;
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        int channelId = 1234567;
        String startDate = "2020-08-01";
        String endDate = "2020-08-18";
        params.put("channelIds", String.valueOf(channelId));
        params.put("startDate", startDate);
        params.put("endDate", endDate);
        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/statistics/concurrence-mc

接口说明

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

1、接口用于获取多个频道下的历史并发记录(聚合数据,按照时间升序排序)
2、日期参数跨天则天为粒度,一天之内则以分钟为粒度返回
3、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelIds string 频道号,多个频道以,隔开
startDate string 开始日期格式,yyyy-MM-dd,时间跨度不得超过31天
endDate string 结束日期格式,yyyy-MM-dd,时间跨度不得超过31天

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "day": "2020-08-16",
            "minute": "00:00",
            "viewers": 0
        },
        {
            "day": "2020-08-17",
            "minute": "00:00",
            "viewers": 2
        },
        {
            "day": "2020-08-18",
            "minute": "00:00",
            "viewers": 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": 403, 
  "status": "error", 
  "message": "illegal channel id: 1234567", 
  "data": ""
}

频道号格式错误

{
  "code": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

日期范围错误

{
  "code": 400, 
  "status": "error", 
  "message": "startDate can not great endDater", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 获取多个频道下的历史并发记录(聚合数据)

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/statistics/concurrence-mc;
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        int channelId = 1234567;
        String startDate = "2020-08-01";
        String endDate = "2020-08-18";
        params.put("channelId", String.valueOf(channelId));
        params.put("startDate", startDate);
        params.put("endDate", endDate);
        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/statistics/browsers-summary

接口说明

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

1、接口用于获取多个频道下(聚合查询结果)的终端分布信息
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId string 频道号,多个频道以,隔开
startDate string 开始日期格式,yyyy-MM-dd
endDate string 结束日期格式,yyyy-MM-dd

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
            "browser": "Chrome 浏览器",
            "count": 69,
            "platform": "pc",
            "percent": 98.57
        },
        {
            "browser": "IE 11.0 浏览器",
            "count": 1,
            "platform": "pc",
            "percent": 1.43
        }]
}

响应失败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": 403, 
  "status": "error", 
  "message": "illegal channel id: 1234567", 
  "data": ""
}

频道号格式错误

{
  "code": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

日期范围错误

{
  "code": 400, 
  "status": "error", 
  "message": "startDate can not great endDater", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 日期区间内的多个频道下(聚合查询结果)的终端分布信息

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/statistics/browsers-summary;
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        int channelId = 1234567;
        String startDate = "2020-08-01";
        String endDate = "2020-08-18";
        params.put("channelId", String.valueOf(channelId));
        params.put("startDate", startDate);
        params.put("endDate", endDate);
        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

http://api.polyv.net/live/v3/channel/product/getListByRank

接口说明

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

1、通过频道号和排序号获取排序号之后的上架商品列表
2、不传排序号获取最前面的上架商品列表
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "total": 1,
        "content": [
            {
                "productId": 2128,
                "userId": "ee7fe7fbda",
                "channelId": 1779741,
                "name": "goods01",
                "price": null,
                "cover": "//liveimages.videocc.net/uploadimage/20200707/chat_img_1779741_15941158896246.png?x-oss-process=image/crop,x_142,y_142,w_355,h_355",
                "link": "http://www.msuno.cn",
                "status": 1,
                "createdTime": 1594115895000,
                "lastModified": 1597388856000,
                "rank": 11,
                "realPrice": 12.98,
                "type": "live",
                "linkType": 10,
                "pcLink": "",
                "mobileLink": "",
                "wxMiniprogramLink": "",
                "wxMiniprogramOriginalId": ""
            }
        ]
    }
}

响应失败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 响应结果集
total int 总上架商品数量
content array 商品列表
productId int 商品唯一Id
userId int 用户userId
channelId int 频道号
name int 商品名称
price int 商品价格
cover int 商品图片
link int 商品通用跳转链接
status int 商品状态,上架:1,只返回上架状态
createdTime int 创建时间
lastModified int 修改时间
rank int 商品排序号
realPrice int 商品真实价格
type int 商品类型,live:直播后台商品
linkType int 商品跳转类型,10:通用跳转,11:多平台跳转
pcLink int pc端商品跳转链接
mobileLink int 手机端商品跳转链接
wxMiniprogramLink int wx商品跳转链接
wxMiniprogramOriginalId int wx商品跳转链接中的原id

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/product/getListByRank";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        param.put("channelId", "0000000");
        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/stream/stop-pull-stream

接口说明

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

1、执行停止拉流直播操作
2、接口支持https

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

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

Java请求示例

public static void testStopPullStream() {
        String url = "https://api.polyv.net/live/v3/channel/stream/stop-pull-stream";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        int channelId = 10001;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", String.valueOf(channelId));
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params);
        System.out.println(content);
    }

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

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

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