查询直播日历
更新时间:2026-07-23 14:37:39
接口描述
1、按时间范围查询账号下的直播安排(直播日历),返回时间范围内逐日的直播列表
2、仅返回已设置直播时间的频道;开启了系列直播(多场次)的频道,按场次返回,并携带场次ID和场次名称
3、接口支持https协议
接口URL
https://api.polyv.net/live/v4/user/live-calendar/list
请求方式
GET
接口约束
1、接口同时支持HTTP、HTTPS,建议使用HTTPS确保接口安全,接口调用有频率限制,详细请查看
2、startDate、endDate 为必填,且 startDate 不能大于 endDate,查询跨度不能超过 35 天
3、日历仅包含已设置直播时间的频道,未设置直播时间的频道不会出现在返回结果中
4、返回结果按天铺满整个查询区间,当天没有直播时 lives 为空数组
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| startDate | true | String | 查询开始日期,格式:yyyy-MM-dd |
| endDate | true | String | 查询结束日期,格式:yyyy-MM-dd,须大于等于 startDate,且与 startDate 的跨度不超过 35 天 |
示例
https://api.polyv.net/live/v4/user/live-calendar/list?appId=frlr1zazn3×tamp=1720406400000&startDate=2026-08-01&endDate=2026-08-03&sign=14A0FA6A31D03D9D1164F55A14E6DB5B
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Object | 直播日历信息【详见data字段说明】 |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| dailyLiveSchedules | Array | 按天分组的直播安排列表,查询区间内每一天都会返回一项【详见dailyLiveSchedules字段说明】 |
dailyLiveSchedules参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| date | String | 日期,格式:yyyy-MM-dd |
| lives | Array | 当天的直播列表,按开始时间升序;当天没有直播时为空数组【详见lives字段说明】 |
lives参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | Integer | 频道号 |
| channelName | String | 频道名称 |
| sessionId | String | 场次ID,仅开启了系列直播(多场次)的频道返回,未开启时返回 null |
| sessionName | String | 场次名称,仅开启了系列直播(多场次)的频道返回,未开启时返回 null |
| startTime | Long | 直播开始时间,13位毫秒级时间戳 |
| endTime | Long | 直播结束时间,13位毫秒级时间戳;未设置结束时间时返回 null |
| teacherName | String | 主讲昵称,未设置时返回 null |
| teacherActor | String | 主讲头衔,未设置时返回 null |
| teacherAvatar | String | 主讲头像地址,未设置时返回 null |
| status | String | 直播状态【详见直播状态说明】 |
直播状态说明
| status | 说明 |
|---|---|
| live | 正在直播 |
| pause | 暂停中 |
| playback | 直播回放 |
| waiting | 等待直播 |
| unStart | 未开始 |
| end | 直播结束 |
| testing | 调试中 |
| banpush | 已禁播 |
| expired | 已超时 |
Java请求示例
快速接入基础代码请下载相关依赖源码,点击下载源代码,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(UserTest.class);
/**
* 查询直播日历
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testListLiveCalendar() throws IOException, NoSuchAlgorithmException {
// 公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
// 业务参数
String url = "https://api.polyv.net/live/v4/user/live-calendar/list";
// http调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("startDate", "2026-08-01");
requestMap.put("endDate", "2026-08-03");
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询直播日历成功:{}", response);
// do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "7c4ef056-1f32-4dfe-a970-5d29515ab600",
"data": {
"dailyLiveSchedules": [
{
"date": "2026-08-01",
"lives": [
{
"channelId": 1234567,
"channelName": "8月新品发布会",
"sessionId": null,
"sessionName": null,
"startTime": 1785000000000,
"endTime": 1785010800000,
"teacherName": "张三",
"teacherActor": "讲师",
"teacherAvatar": "//s1.videocc.net/default-img/avatar/teacher.png",
"status": "waiting"
}
]
},
{
"date": "2026-08-02",
"lives": [
{
"channelId": 7654321,
"channelName": "8月系列课",
"sessionId": "hklgq621x0",
"sessionName": "第一场",
"startTime": 1785088800000,
"endTime": 1785096000000,
"teacherName": "李四",
"teacherActor": "讲师",
"teacherAvatar": "//s1.videocc.net/default-img/avatar/teacher.png",
"status": "unStart"
}
]
},
{
"date": "2026-08-03",
"lives": []
}
]
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 10001,
"desc": "开始日期不能大于结束日期,且查询跨度不能超过35天"
},
"success": false
}
