保利威文档中心

幫助中心

修改影片庫單一影片的上移、下移(包含點播列表和回放列表)

更新時間:2024-07-29 11:17:04

接口描述

1、修改视频库单个视频的上移、下移(包括点播列表和回放列表)
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/playback/single-sort

線上API呼叫

請求方式

POST

接口限制

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

請求參數說明

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

範例

https://api.polyv.net/live/v3/channel/playback/sort?appId=frlr1zazn3&sign=840FF35DB291A8C010F7CE14A0A985CA&videoId=xxxxx&listType=vod&channelId=2139283&timestamp=1621841731282

回應參數說明

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

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 testSetPlaybackSingleSort() 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/channel/playback/single-sort";
    String channelId = "2139283";
    String videoId = "xxxx";
    String type = "up"
    String listType = "vod";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("listType", listType);
    requestMap.put("videoId", videoId);
    requestMap.put("type", type);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改视频库单个视频的上移、下移(包括点播列表和回放列表),返回值:{}", response);
    //do somethings
    
}

回應範例

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

成功範例

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

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "playback video unable to sort",//排序异常或者无需排序
    "data": ""
}
联系客服,在线咨询