保利威文档中心

幫助中心

查詢所有頻道的回放影片

更新時間:2025-03-07 11:50:38

介面描述

1、查询账号下回放列表和点播列表, 注意:不包括暂存列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/user/playback/list

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳,3分鐘內有效
channelId false String 頻道號,不傳則查詢帳號下所有回放影片
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
page false String 頁碼,預設為1
pageSize false String 每頁資料大小,預設為20,合法範圍為1-1000
order false String 排序規則,取值
timeDesc:按createdTime降序
rankDesc:按rank降序
time:按createdTime升序
rank:按rank升序,預設為timeDesc
listType false String playback:回放列表
vod:點播列表,預設為playback

範例

https://api.polyv.net/live/v3/user/playback/list?categoryIds=340019%2C345134&appId=frlr1zazn3&sign=CD602DA08E520D4EA28F20554907E0F2&pageSize=2&page=2&listType=playback&timestamp=1621841524123&order=timeDesc

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 回應成功時返回回放影片列表資訊【詳見data欄位說明
Data參數描述
參數名 類型 說明
pageSize Integer 每頁資料大小,預設10,最大值1000
pageNumber Integer 目前頁數
totalItems Integer 總筆數
contents Array 查詢的結果列表【詳見Contents參數描述
startRow Integer 目前頁第一筆記錄在總結果集中的位置
firstPage Boolean 是否為第一頁,值為:true/false,預設false
lastPage Boolean 是否為最後一頁,值為:true/false,預設false
prePageNumber Integer 上一頁編號
limit Integer 每頁數量大小
nextPageNumber Integer 下一頁編號
endRow Integer 目前頁最後一筆記錄在總結果集中的位置
totalPages Integer 總頁數
offset Integer 分頁起始記錄
Contents參數描述
參數名 類型 說明
videoId String 直播系統產生的id (影片庫中的回放影片)
videoPoolId String 點播影片vid (影片庫中的回放影片)
userId String POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->直播(開發設定)
channelId String 回放影片對應的直播頻道號
title String 影片標題
firstImage String 影片首圖
duration String 影片長度,格式為HH:mm:ss
myBr String 預設影片的播放清晰度
1:流暢
2:高清
3:超清
qid String 訪客資訊收集id
seed Integer 影片加密狀態,1表示為加密狀態,0為非加密
ordertime Integer 關聯點播影片的排序欄位
createdTime Long 新增為回放影片的日期,13位毫秒級時間戳
lastModified Long 影片最後修改日期,13位毫秒級時間戳
rank Integer 排序值,值越大優先級越高
asDefault String 是否為預設播放影片,值為Y/N
Y:是
N:否
url String 影片播放位址,註:如果影片為加密影片,則此位址無法存取
channelSessionId String 用於PPT請求資料,與PPT直播的回放相關,一般直播回放值為null
status String 轉存點播影片完成狀態,已完成:Y,未完成:N
fileUrl String 影片位址
fileId String 回放影片轉存前的暫存fileId
startTime String 直播開始時間,格式:yyyyMMddHHmmss
liveType String 直播類型
alone:活動直播
ppt:三分屏
topclass:大班課
seminar:研討會
width Integer 影片寬度,返回為null,暫不返回具體值
height Integer 影片高度,返回為null,暫不返回具體值
origin String 轉存檔案來源
manual:手動錄製
auto:自動錄製
merge:合併
clip:裁剪
smart-clip:智慧裁剪,返回為null,暫不返回具體值
callbackUrl String 轉存影片時設定的回呼位址,返回為null,暫不返回具體值
errorCount Integer 處理失敗的次數,返回為null,暫不返回具體值
lang String 語言
zh_CN:中文
EN:英文,返回為null,暫不返回具體值
videoIdEN String 英文回放videoId,返回為null,暫不返回具體值
enFileUrl String 英文回放檔案位址,返回為null,暫不返回具體值
mergeinfo String 影片合併資訊
watchUrl String 觀看回放影片的位址

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、例外處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 查询所有频道的回放视频
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUserPlaybackList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/user/playback/list";
    String categoryIds="340019,345134";
    String page = "2";
    String pageSize="2";
    String order="timeDesc";
    String listType="playback";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryIds", categoryIds);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("order", order);
    requestMap.put("listType", listType);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询所有频道的回放视频,返回值:{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "pageSize":2,
        "pageNumber":2,
        "totalItems":8,
        "contents":[
            {
                "videoId":"8073e37567",
                "videoPoolId":"1b448be323a9076c9941604ac1c667f9_1",
                "userId":"1b448be323",
                "channelId":1965681,
                "title":"Junit测试(勿删)",
                "firstImage":"//doc.polyv.net/images/default/blackboard.png",
                "duration":"05:15:01",
                "myBr":"1",
                "qid":null,
                "seed":0,
                "ordertime":0,
                "createdTime":1610358017000,
                "lastModified":1615521715000,
                "rank":3,
                "asDefault":"N",
                "url":"https://hls.videocc.net/source/1b448be323/9/1b448be323a9076c9941604ac1c667f9_1.m3u8",
                "channelSessionId":"fsz5i7qzr2",
                "status":"Y",
                "fileUrl":"http://oss-live-2.videocc.net/record/2020-11-12/1b448be3231603155365715c1aa/recordmerge-20201112093918.m3u8",
                "fileId":"0145efa91ec0b1bf6f82cc2f6ac98abb",
                "startTime":"20201028110419",
                "liveType":"ppt",
                "width":null,
                "height":null,
                "origin":null,
                "callbackUrl":null,
                "errorCount":null,
                "lang":null,
                "videoIdEN":null,
                "enFileUrl":null,
                "mergeinfo":"["20201028110421,18617,fsiog0shsh","20201028161448,4,fsix03jel5","20201028161455,65,fsix07id6x","20201028161618,38,fsix2mm1qj","20201028161705,119,fsix3fcffb","20201028164653,63,fsixx18b0p"]",
                "watchUrl":"//live.polyv.cn/watch/1965681?vid=8073e37567"
            },
            {
                "videoId":"b24edc10fd",
                "videoPoolId":"1b448be3230a0194d959426ae005645f_1",
                "userId":"1b448be323",
                "channelId":1965681,
                "title":"Junit测试(勿删)",
                "firstImage":"//doc.polyv.net/images/default/blackboard.png",
                "duration":"00:03:00",
                "myBr":"1",
                "qid":null,
                "seed":0,
                "ordertime":0,
                "createdTime":1610358014000,
                "lastModified":1615521715000,
                "rank":2,
                "asDefault":"N",
                "url":"https://hls.videocc.net/source/1b448be323/f/1b448be3230a0194d959426ae005645f_1.m3u8",
                "channelSessionId":"ftmnaan4l3",
                "status":"Y",
                "fileUrl":"https://oss-live-2.videocc.net/record/record/recordf/1b448be3231603155365715c1aa/1b448be3230a0194d959426ae005645f/2020-12-03-17-03-44_2020-12-03-17-06-53.m3u8",
                "fileId":"387c5c4ca5f5d8aef24726ed3f0845b7",
                "startTime":"20201203170345",
                "liveType":"ppt",
                "width":null,
                "height":null,
                "origin":null,
                "callbackUrl":null,
                "errorCount":null,
                "lang":null,
                "videoIdEN":null,
                "enFileUrl":null,
                "mergeinfo":"["20201203170401,174,ftmnaan4l3"]",
                "watchUrl":"//live.polyv.cn/watch/1965681?vid=b24edc10fd"
            }
        ],
        "startRow":3,
        "firstPage":false,
        "lastPage":false,
        "prePageNumber":1,
        "limit":2,
        "nextPageNumber":3,
        "endRow":4,
        "totalPages":4,
        "offset":2
    }
}

異常範例

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