查詢播放清單詳情

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

介面說明

1、通过播放列表id查询用户视频播放列表详情信息
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口URL中的{id}为点播账号播放列表id，具体参考【获取所有播放列表】
4、接口支持https协议

介面URL

http://api.polyv.net/v2/play/{userid}/list/{id}

請求方式

GET

介面限制

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

請求參數說明

參數名	必選	類型	說明
userid	true	String	保利威點播帳戶id，可參考【取得金鑰】取得，取得路徑：官網->登入->點播（API介面）
ptime	true	Long	目前時間的毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
id	true	String	播放清單id【可透過取得所有播放清單取得】
format	false	String	回傳的資料格式，預設回傳json格式 xml：回傳xml格式 json：回傳json格式

範例

http://api.polyv.net/v2/play/1b448be323/list/1617177069967?format=json&sign=2F6FC9DE4F3901D654B85E92FE98A30AC07CE316&id=1617177069967&userid=1b448be323&ptime=1617183364138

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Array	回應成功時回傳影片詳細資訊【詳見data欄位說明】

data參數說明

欄位	類型	說明
describ	String	播放清單描述
tag	String	播放清單標籤
title	String	播放清單標題
lmodify	String	最後修改時間，格式為：yyyy-MM-dd HH:mm:ss
video_count	String	播放清單影片數量
videoid	String	播放清單id
ptime	String	建立時間，格式為：yyyy-MM-dd HH:mm:ss
videolist	Array	影片集合【詳見videolist參數說明】

videolist參數說明

欄位	類型	說明
vid	String	影片id
title	String	影片標題
duration	String	影片時長，格式為：HH:mm:ss，例如：00:03:11
publish_url	String	外部連結
first_image	String	影片首圖
default_videolink	String	預設影片連結位址

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodPlaylistTest.class);
/**
 * 查询播放列表详情
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetPlaylistDetail() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String id = "1617177069967";
    String format = "json";
    
    String url = String.format("http://api.polyv.net/v2/play/%s/list/%s", userId, id);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("id", id);
    requestMap.put("format", format);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    
    String response = HttpUtil.get(url, requestMap);
    log.debug("测试查询播放列表详情,{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": [
        {
            "describ": "测试修改描述",
            "tag": "测试标签",
            "title": "测试创建播放列表接口123",
            "lmodify": "2021-03-31 17:13:21",
            "video_count": "1",
            "videoid": "1617177069967",
            "ptime": "2021-03-31 15:51:09",
            "videolist": [
                {
                    "vid": "1b448be323b8d9b9489dcd7e8e09f087_1",
                    "title": "测试视频-jjjjj",
                    "duration": "00:02:19",
                    "publish_url": "",
                    "first_image": "http://img.videocc.net/uimage/1/1b448be323/7/1b448be323b8d9b9489dcd7e8e09f087_0.jpg",
                    "default_videolink": ""
                }
            ]
        }
    ]
}

異常範例

簽名不正確

{
    "code": 400,
    "status": "error",
    "message": "the sign is not right",
    "data": ""
}