查詢系列直播場次資訊
更新時間:2026-10-12 15:41:28
介面描述
1、查询系列直播场次信息
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/channel/session/new/get
請求方式
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×tamp=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 | 計畫開始時間 |
| playbackConfig | Object | 場次回放配置 【詳見playbackConfig欄位描述】 |
| playbackEnabled | String | 場次回放開關(Y:開啟,N:關閉) |
| 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 | 觀看位址 |
playbackConfig欄位描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| playbackEnabled | String | 場次回放開關(Y:開啟,N:關閉) |
| playbackOrigin | String | 場次回放來源(record:本場直播錄製,material:素材庫,vod:隨選視訊) |
| videoId | String | 場次回放視訊ID,來源為素材庫時為素材ID,為隨選視訊時為隨選視訊ID;來源為本場直播錄製時為空 |
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,
"playbackEnabled": "Y",
"playbackConfig": {
"playbackEnabled": "Y",
"playbackOrigin": "vod",
"videoId": "c81017120b"
},
"watchUrl": "https://live.polyv.net/2588188/e9s2h3jd8f",
"userId": "user123"
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
