保利威文档中心

帮助中心

查询系列直播场次信息

更新时间:2026-07-27 15:03:28

接口描述

1、查询系列直播场次信息
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/session/new/get

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥
timestamp true Long 当前13位毫秒级时间戳,3分钟内有效
sign true String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
channelId false Integer 频道号
sessionId false String 场次ID

示例

http://api.polyv.net/live/v4/channel/session/new/get?appId=frlr1zazn3&timestamp=1632809855078&channelId=2588188&sessionId=e9s2h3jd8f&sign=D02FA683640135D843D485EE84F6632A

响应参数描述

参数名 类型 说明
code Integer 响应状态码,200为成功返回,非200为失败【详见全局错误说明
status String 响应状态文本信息
message String 响应描述信息,当code为400或者500的时候,辅助描述错误原因
data Object 请求失败时为空,请求成功时为频道场次信息 【详见data字段描述

data字段描述

参数名 类型 说明
channelId Integer 频道ID
createdTime Long 场次开始时间
diskVideoVO Object 硬盘推流视频信息 【详见diskVideoVO字段描述
endTime Long 场次结束时间
interactionScriptVO Object 互动脚本信息 【详见interactionScriptVO字段描述
name String 场次名称
planEndTime Long 计划结束时间
planStartTime Long 计划开始时间
pushClient String 推流客户端类型
sessionId String 场次ID
splashImg String 封面图
splashImgBackgroundId Integer 封面图的背景模板ID
splashLargeImg String 竖屏、大图模式的封面图
status String 场次状态(unStart:未开始,live:直播中,end:已结束,playback:回放中,expired:已过期)
streamType String 流类型
userId String POLYV用户ID
watchUrl String 观看地址

diskVideoVO字段描述

参数名 类型 说明
channelId Integer 频道ID
createdTime Long 创建时间
duration String 时长(格式:HH:mm:dd)
durationSecond Integer 时长(秒)
endTime Long 结束时间
fileSize Long 文件大小
firstImage String 首帧图片
playType String 播放类型(normal:普通播放,loop:循环播放)
startTime Long 开始时间
status String 状态
title String 标题
url String URL
userId String 用户ID
videoId String 伪直播ID
videoPoolId String 视频ID

interactionScriptVO字段描述

参数名 类型 说明
id Integer 脚本ID(主键)
name String 脚本名称

Java请求示例

快速接入基础代码请下载相关依赖源码点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 获取新场次信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    //API请求地址
    String url = "http://api.polyv.net/live/v4/channel/session/new/get";
    String timestamp = String.valueOf(System.currentTimeMillis());
    //请求参数
    Map<String, String> params = new HashMap<String, String>();
    params.put("appId", appId);
    params.put("timestamp", timestamp);
    params.put("channelId", "2588188");
    params.put("sessionId", "e9s2h3jd8f");
    //生成签名
    String sign = LiveSignUtil.getSign(params, appSecret);
    params.put("sign", sign);
    //发送请求
    String result = HttpUtil.sendGet(url, params);
    //打印结果
    log.info("返回值:{}", response);
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 2588188,
        "sessionId": "e9s2h3jd8f",
        "name": "测试场次1",
        "endTime": 1761201953000,
        "status": "end",
        "createdTime": 1761201953000,
        "planStartTime": 1761201953000,
        "planEndTime": 1761201953000,
        "streamType": "client",
        "pushClient": "web",
        "splashImg": "https://example.com/image1.jpg",
        "splashLargeImg": "https://example.com/large-image1.jpg",
        "splashImgBackgroundId": 1,
        "watchUrl": "https://live.polyv.net/2588188/e9s2h3jd8f",
        "userId": "user123"
    }
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询