你的位置：首页 / 云直播 / 直播平台API

网页启动直播客户端

由发表

提供网页启动客户端的一种支持，让您快速从页面中启动polyv直播客户端，而不必去应用程序列表中查找

新版（4.x）客户端启动

注：只适用于新版客户端，旧版客户端会打开失败

const client4xStart = 'polyvlive';
const url = `${client4xStart}://start?channelId=${channelId}&passwd=${password}&pdn=api.polyv.net`;
window.location.assign(url);

注：channelId为频道号，password为密码，下同

旧版客户端启动（目前新旧版都兼容，之后新版客户端会移除支持）

const clientStart = 'polyvlive';
const url = `${clientStart}:/${channelId}&${password}`;
window.location.assign(url);

示例

demo

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

统计直播间内多场次的直播和观看数据

由发表

接口URL

https://api.polyv.net/live/v3/channel/statistics/get-session-stats

接口说明

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

1、接口用于统计直播间内多场次的直播和观看数据
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 long 13位当前毫秒级时间戳
sign 是 string 签名值
channelId 是 int 频道号
sessionIds 否 string 场次ID,多个场次使用','分隔，场次ID和直播开始结束时间必填一项,场次ID和直播开始结束时间同时存在时，使用场次ID进行查询
startTime 否 long 直播开始时间13位毫秒级时间戳，开始时间和结束时间相隔不可以超过30天,场次ID和直播开始结束时间必填一项
endTime 否 long 直播结束时间13位毫秒级时间戳，场次ID和直播开始结束时间必填一项

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "list": [
            {
                "channelId": 1947328,
                "sessionId": "fvipafupmh",
                "name": "test",
                "startTime": 1612319385000,
                "duration": 595,
                "liveUV": 1,
                "livePV": 6,
                "playbackPV": 6,
                "playbackUV": 2
            },
            {
                "channelId": 1947328,
                "sessionId": "fw82mayhuy",
                "name": "test",
                "startTime": 1614307485000,
                "duration": 49,
                "liveUV": 1,
                "livePV": 1,
                "playbackPV": 2,
                "playbackUV": 1
            }
        ]
    }
}

响应字段说明

参数名 说明
code 状态码,成功为200，签名失败为403，参数错误为400，服务端错误为500
status 成功为success,错误时为error
message 成功为""，错误时为错误描述信息
data 响应数据
data.list.channelId 频道ID
data.list.sessionId 场次ID
data.list.name 场次名称
data.list.startTime 场次开始时间,时间戳
data.list.duration 直播时长,单位秒
data.list.livePV 直播观看人次
data.list.liveUV 直播观看人数
data.list.playbackPV 回看观看人次
data.list.playbackUV 回看观看人数

响应失败JSON示例：

参数错误

{
    "code": 400,
    "status": "error",
    "message": "param validate error",
    "data": ""
}

未输入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: %s",
    "data": ""
}

java请求示例

public void testAddRecordTask() {
        String url = "https://api.polyv.net/live/v3/channel/pptRecord/get-setting";
        // appId和加密串
        String appId = "xxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxx";
        int channelId = 123;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", String.valueOf(channelId));
        params.put("sessionIds", "fw82mayhuy,fvipafupmh");

        // 调用Polyv的工具类方法设置sign
        PolyvTool.setLiveSign(params, appId, appSecret);
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params);
        System.out.println(content);
}

签名规则及工具文件代码

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

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

多频道手动结束问卷

由发表

接口URL

http://api.polyv.net/live/v3/channel/questionnaire/end

接口说明

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

1、接口用于设置频道的简单详情信息
2、接口支持https

返回结果支持格式

JSON

请求方式

GET、POST

请求参数

参数名 必选 类型 说明
appId 是 string 管理员的appId
timestamp 是 long 13位当前时间戳
sign 是 string 签名值
channelIds 是 string 频道id,多个频道用","分隔

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "result": 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 响应代码，成功为200，失败为400，签名错误为403，异常错误500
status 成功为success，失败为error
message 错误时为错误提示消息
data.result 处理结果, true成功，false失败

java请求示例

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/questionnaire/end";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        String channelIds = "10001,1002";
        Map<String, String> params = new HashMap<>();
        params.put("channelIds", channelIds);
        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/chat/remove-contents

接口说明

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

1、根据聊天的id删除对应聊天记录
2、接口支持https协议
3、接口支持批量删除操作

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
channelId 是 int 频道ID
ids 是 string 聊天记录对应的id(多个id使用英文逗号隔开)
timestamp 是 string 当前13位毫秒级时间戳，3分钟内有效
sign 是 string 签名，32位大写MD5值

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "remove chat contents 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": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

其他错误

{
    "code": 400,
    "status": "error",
    "message": "remove chat contents occur an error",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求失败时为空，请求成功为成功信息

java请求示例

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/chat/remove-contents";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        int channelId = 10001;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", channelId);
        params.put("ids", "12213,22334");
        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/mic/log/list-detail

接口说明

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

1、接口用于查询连麦详单
2、接口支持https
3、注意：该接口查询的数据并不是实时的，当日数据需在次日下午才能查询到，出数据时间在14:30 ~ 18:00之间

返回结果格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 long 当前13位毫秒级时间戳，3分钟内有效
sign 是 string 签名，为32位大写的MD5值
channelId 是 int 频道号
startDate 是 string 开始日期, 日期格式：yyyy-MM-dd，如2020-10-01，时间范围不能超过30天
endDate 是 string 结束日期, 日期格式：yyyy-MM-dd，如2020-10-01，时间范围不能超过30天
page 否 int 当前页码，默认为1
pageSize 否 int 每页大小，默认500条，最大5000条，超过5000条可以分多批拉取，每次page加1，直到返回列表contents为空

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "page": 1,
        "pageSize": 500,
        "contents": [
            {
                "channelId": "xxxxxxx",
                "identity": "guest",
                "viewerId": "xxxxxxx",
                "nickname": "王老师",
                "joinTime": 1603596135000,
                "leaveTime": 1603596647000,
                "sessionId": "xxxxxxx"
            }
        ]
    }
}

响应失败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
data 响应结果
message 异常错误信息
channelId 频道号
sessionId 场次号
viewerId 观众ID
identity 身份，嘉宾：guest、学员：student
nickname 昵称
joinTime 进入 rtc 的时间, 13位毫秒时间戳
leaveTime 离开 rtc 的时间, 13位毫秒时间戳

Java请求示例

public void test() {
        String url = "https://api.polyv.net/live/v3/channel/mic/log/list-detail";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", String.valueOf(1234567));
        params.put("startDate", "2020-10-22");
        params.put("enddate", "2020-10-23");
        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/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 观看回放视频的地址
qid 关联点播视频的访客信息收集设置
ordertime 关联点播视频的排序字段
status 关联点播视频的状态，60、61审核通过
fileUr1 视频地址
fileId 回放视频转存前的暂存fileId
liveType 直播类型：alone(活动直播);ppt(三分屏);topclass(大班课);seminar(研讨会)
width 视频宽度
height 视频高度
origin 转存文件来源：manual（手动录制）；auto（自动录制）；merge（合并）；clip（裁剪）
callbackUrl 转存视频时设置的回调地址
errorCount 处理失败的次数
lang 语言 zh_CN中文、EN英文
videoIdEN 英文回放videoId
enFileUrl 英文回放文件地址
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值大写
categoryIds 否 string 分类ID，多个id用","分隔
page 否 int 查询页数，默认1
pageSize 否 int 每页大小，默认20，最大20

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 5,
        "contents": [
            {
                "channelId": 1947328,
                "name": "阿里云",
                "publisher": "主持人",
                "startTime": 1604113200000,
                "pageView": 110,
                "likes": 1,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2020/11/ftbm6uuzoa.jpg",
                "splashEnabled": "N",
                "desc": "",
                "maxViewer": -1,
                "watchStatus": "playback",
                "watchStatusText": "回放中",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": [
                    {
                        "videoId": "63af1f1bff",
                        "videoPoolId": "cf7f07e096aa3c17fa480f0822b1a990_c"
                    }
                ],
                "categoryId": 341097
            },
            {
                "channelId": 1947327,
                "name": "华为云",
                "publisher": "主持人",
                "startTime": 0,
                "pageView": 6,
                "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": null,
                "videoList": [
                    {
                        "videoId": "052f4509f2",
                        "videoPoolId": "cf7f07e096152ef186b0ea9b247998cd_c"
                    }
                ],
                "categoryId": 341097
            },
            {
                "channelId": 1947326,
                "name": "ucloud",
                "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": "end",
                "watchStatusText": "已结束",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": [
                    {
                        "videoId": "1138f32f38",
                        "videoPoolId": "cf7f07e0965e6522206f6a8868dd39f0_c"
                    },
                    {
                        "videoId": "ac020d89cd",
                        "videoPoolId": "cf7f07e09621aa213e19929565a0d08f_c"
                    }
                ],
                "categoryId": 341097
            },
            {
                "channelId": 1947324,
                "name": "金山云",
                "publisher": "主持人",
                "startTime": 0,
                "pageView": 1,
                "likes": 0,
                "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": [
                    {
                        "videoId": "941d2ebfb6",
                        "videoPoolId": "cf7f07e0961129e67a9d11c73685f3dc_c"
                    },
                    {
                        "videoId": "553b71d9f9",
                        "videoPoolId": "cf7f07e096795233489f311d9e0d64f7_c"
                    }
                ],
                "categoryId": 341097
            },
            {
                "channelId": 1947220,
                "name": "网宿",
                "publisher": "主持人",
                "startTime": 0,
                "pageView": 12,
                "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": null,
                "videoList": [
                    {
                        "videoId": "da8de8de37",
                        "videoPoolId": "cf7f07e0961c4ba7e6279ea1add9fc37_c"
                    },
                    {
                        "videoId": "1e9c53a8cd",
                        "videoPoolId": "cf7f07e096b83531e76910375f2b62ec_c"
                    }
                ],
                "categoryId": 341097
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "prePageNumber": 1,
        "limit": 5,
        "endRow": 5,
        "nextPageNumber": 1,
        "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 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对象
categoryId int 分类ID

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/product/update

接口说明

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

1、编辑频道商品库商品信息
2、接口支持https

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

请求体参数

参数名 必选 类型 说明
productId 是 int 商品库商品productId
name 是 string 商品名称，必填，长度范围：1-60
price 否 long 商品价格，保留两位小数，如：0.01
cover 是 string 商品封面链接，必填，长度范围：1-500
link 否 string 通用链接（linkType=10），商品链接，必填，长度1-500
多平台链接（linkType=11），非必填
status 是 int 商品上下架状态
1：上架状态
2：下架状态
realPrice 是 long 商品实际价格，保留两位小数，如：0.01
linkType 是 int 商品链接类型
10：通用链接
11：多平台链接
pcLink 否 string 多平台链接（linkType=11），pc端跳转链接，必填，长度1-500
通用链接（linkType=10），非必填
mobileLink 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
wxMiniprogramLink 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
wxMiniprogramOriginalId 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
mobileAppLink 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
params 否 string 自定义参数，类型json对象，需要转为string

请求体参数示例

{
    "productId": 1,
    "name": "king d",
    "price": 100.01,
    "cover": "//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235",
    "link": "",
    "status": 1,
    "realPrice": 19.02,
    "linkType": 11,
    "pcLink": "https://www.msuno.cn",
    "mobileLink": "",
    "wxMiniprogramLink": "",
    "wxMiniprogramOriginalId": "",
    "mobileAppLink": "",
    "params": "{\"cc\": 11}"
}

响应成功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": 403,
    "status": "error",
    "message": "illegal channel id: xxxxxx",
    "data": ""
}

必填参数为空

{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: pcLink",
    "data": ""
}

字段说明

参数名 类型 说明
code int 响应代码，成功为200，失败为400，签名错误为401，异常错误500
status string 成功为success，失败为error
message string 错误时为错误提示消息
data string 暂无作用

Java请求示例

public static void main(String[] args) {
        String url = "https://api.polyv.net/live/v3/channel/product/update";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        PolyvTool.setLiveSign(params, appId, appSecret);
        String body = "{\"productId\":1,\"name\":\"king==d\",\"price\":100.01,\"cover\":\"//liveimages.videocc" +
                ".net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0," +
                "w_235,h_235\",\"link\":\"\",\"status\":1,\"realPrice\":19.02,\"linkType\":11," +
                "\"pcLink\":\"https://www.msuno.cn\",\"mobileLink\":\"\",\"wxMiniprogramLink\":\"\"," +
                "\"wxMiniprogramOriginalId\":\"\",\"mobileAppLink\":\"\",\"params\":\"{\\\"cc\\\":11}\"}";
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPostJson(url + "?" + PolyvTool.mapJoinNotEncode(params), body, null);
        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/add

接口说明

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

1、添加频道商品库商品
2、接口支持https

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

请求体参数

参数名 必选 类型 说明
name 是 string 商品名称，必填，长度范围：1-60
price 否 long 商品价格，保留两位小数，如：0.01
cover 是 string 商品封面链接，必填，长度范围：1-500
link 否 string 通用链接（linkType=10），商品链接，必填，长度1-500
多平台链接（linkType=11），非必填
status 是 int 商品上下架状态
1：上架状态
2：下架状态
realPrice 是 long 商品实际价格，保留两位小数，如：0.01
linkType 是 int 商品链接类型
10：通用链接
11：多平台链接
pcLink 否 string 多平台链接（linkType=11），pc端跳转链接，必填，长度1-500
通用链接（linkType=10），非必填
mobileLink 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
wxMiniprogramLink 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
wxMiniprogramOriginalId 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
mobileAppLink 否 string 多平台链接（linkType=11），pc端跳转链接，长度1-500
params 否 string 自定义参数，类型json对象，需要转为string
productType 否 string 商品类型,normal:普通商品,finance:金融商品
btnShow 否 string 按钮显示文案
features 否 string 产品特色,卖点标签，可以多个,json字段，如：["tab1", "tab2"]
productDesc 否 string 产品描述,支持特殊字符
yield 否 string 产品收益率/价格

请求体参数示例

{
    "name": "king d",
    "price": 100.01,
    "cover": "//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235",
    "link": "",
    "status": 1,
    "realPrice": 19.02,
    "linkType": 11,
    "pcLink": "https://www.msuno.cn",
    "mobileLink": "",
    "wxMiniprogramLink": "",
    "wxMiniprogramOriginalId": "",
    "mobileAppLink": "",
    "params": "{\"cc\": 11}"
}

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "productId": 6296,
        "userId": "ee7fe7fbda",
        "channelId": 1779741,
        "name": "king der",
        "price": null,
        "cover": "//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235",
        "link": "",
        "status": 1,
        "createdTime": 1599616864000,
        "lastModified": 1599616864000,
        "rank": 19,
        "realPrice": 19.02,
        "type": "live",
        "linkType": 11,
        "pcLink": "https://www.msuno.cn",
        "mobileLink": "",
        "wxMiniprogramLink": "",
        "wxMiniprogramOriginalId": "",
        "mobileAppLink": "",
        "params": "{\"cc\": 11}"
    }
}

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

必填参数为空

{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: pcLink",
    "data": ""
}

字段说明

参数名 类型 说明
code int 响应代码，成功为200，失败为400，签名错误为401，异常错误500
status string 成功为success，失败为error
message string 错误时为错误提示消息
data object 商品信息
productId int 商品productId
userId string 用户userId
channelId int 频道号
name string 商品名称
price long 商品价格，保留两位小数，如：0.01
cover string 商品封面链接
link string 商品通用类型商品链接
status int 商品上下架状态
1：上架状态
2：下架状态
createdTime long 创建商品时间，毫秒级时间戳
lastModified long 更新商品时间，毫秒级时间戳
rank int 商品排序号
realPrice long 商品实际价格，保留两位小数，如：0.01
type string 平台标志，默认live,其他无效
linkType int 商品链接类型
10：通用链接
11：多平台链接
pcLink string 多平台链接，pc端跳转链接
mobileLink string 多平台链接，移动web端跳转链接
wxMiniprogramLink string 多平台链接,小程序端跳转链接
wxMiniprogramOriginalId string 多平台链接，小程序端Id
mobileAppLink string 多平台链接，移动App端跳转链接
params string 自定义参数，类型json对象，需要转为string
productType string 商品类型,normal:普通商品,finance:金融商品
btnShow string 按钮显示文案
features string 产品特色,卖点标签，可以多个,json字段，如：["tab1", "tab2"]
productDesc string 产品描述,支持特殊字符
yield string 产品收益率/价格

Java请求示例

public static void main(String[] args) {
        String url = "https://api.polyv.net/live/v3/channel/product/add";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        PolyvTool.setLiveSign(params, appId, appSecret);
        String body = "{\"name\":\"king==d\",\"price\":100.01,\"cover\":\"//liveimages.videocc" +
                ".net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0," +
                "w_235,h_235\",\"link\":\"\",\"status\":1,\"realPrice\":19.02,\"linkType\":11," +
                "\"pcLink\":\"https://www.msuno.cn\",\"mobileLink\":\"\",\"wxMiniprogramLink\":\"\"," +
                "\"wxMiniprogramOriginalId\":\"\",\"mobileAppLink\":\"\",\"params\":\"{\\\"cc\\\":11}\"}";
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPostJson(url + "?" + PolyvTool.mapJoinNotEncode(params), body, null);
        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/delete

接口说明

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

1、删除频道商品库商品
2、接口支持https

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

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

响应成功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": 403,
    "status": "error",
    "message": "illegal channel id: xxxxxx",
    "data": ""
}

非法入参类型错误

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

删除非该频道商品

{
    "code": 400,
    "status": "error",
    "message": "illegal channel product",
    "data": ""
}

字段说明

参数名 类型 说明
code int 响应代码，成功为200，失败为400，签名错误为401，异常错误500
status string 成功为success，失败为error
message string 错误时为错误提示消息
data string 暂无作用

Java请求示例

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