保利威文档中心

幫助中心

修改影片庫的預設影片

更新時間:2022-09-02 18:08:07

介面說明

1、将回放列表中的某个视频设置为默认回放视频
2、接口URL中的{channelId}为频道号
3、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channel/recordFile/{channelId}/playback/set-Default

線上API呼叫

請求方式

POST

介面限制

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

2、一個頻道只能設定一個預設回放影片

請求參數說明

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
videoId true String 直播系統中影片id【videoId可透過查詢影片庫列表取得】
listType false String 影片列表類型,一般直播場景預設為vod,三分割畫面預設為playback
playback:回放列表
vod:點播列表

範例

http://api.polyv.net/live/v2/channel/recordFile/2139283/playback/set-Default

表單參數:

appId=frlr1zazn3&sign=1F5F72A96A084766957D607641389C9C&videoId=73801f70c8&listType=playback&timestamp=1621841600411

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 請求成功返回success,請求失敗返回空

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 设置视频库列表的默认视频
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetRecordDefault() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/channel/recordFile/%s/playback/set-Default";
    String channelId = "2139283";
    String videoId = "73801f70c8";
    String listType = "playback";
    
    url= String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("videoId", videoId);
    requestMap.put("listType", listType);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置视频库列表的默认视频,返回值:{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"success"
}

異常範例

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