Query Live Calendar

API Description

1、按时间范围查询账号下的直播安排（直播日历），返回时间范围内逐日的直播列表
2、仅返回已设置直播时间的频道；开启了系列直播（多场次）的频道，按场次返回，并携带场次ID和场次名称
3、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/live-calendar/list

Online API Call

Request Method

GET

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
   
2. startDate and endDate are required. startDate must not be greater than endDate, and the query span must not exceed 35 days.
   
3. The calendar only includes channels with scheduled live times. Channels without scheduled live times will not appear in the results.
   
4. The results cover the entire query interval by day. When there is no live event on a given day, lives will be an empty array.

Request Parameter Description

Example

https://api.polyv.net/live/v4/user/live-calendar/list?appId=frlr1zazn3&timestamp=1720406400000&startDate=2026-08-01&endDate=2026-08-03&sign=14A0FA6A31D03D9D1164F55A14E6DB5B

Response Parameter Description

Error Parameter Description

data Parameter Description

dailyLiveSchedules Parameter Description

lives Parameter Description

Live Status Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 10001,
        "desc": "开始日期不能大于结束日期，且查询跨度不能超过35天"
    },
    "success": false
}