保利威文档中心

幫助中心

查詢直播日曆

更新時間:2026-07-23 14:37:39

介面描述

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

介面URL

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

線上API呼叫

請求方式

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&timestamp=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
}
联系客服,在线咨询