查詢播放器列表（舊版）

更新時間：2025-02-20 19:09:11

介面描述

目前已有新版本的播口，建議使用新版本介面：查詢播放器列表

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

介面URL

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

線上API呼叫 ``

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
ptime	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】

範例

http://api.polyv.net/v2/play/1b448be323/player-list?sign=1E3CFEEC4EA888571A84156E5BF57EBB35ECAA72&ptime=1617845463779

回應參數描述

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

data欄位說明

欄位	類型	說明
playerName	String	播放器名稱
playerId	String	播放器id，例如"1b448be323"
date	String	建立日期，例如"2020-09-28 14:17:08"
isDefault	Integer	是否為預設播放器 1：是 0：否

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodVideoPlayerTest.class);

/**
 * 查询播放器列表
 */
@Test
public void testGetPlayerList() throws Exception, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String secretKey = super.secretKey;
        String userId = super.userId;
        String ptime = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/v2/play/" + userId + "/player-list";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("userid", userId);
        requestMap.put("ptime", ptime);
        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": [
    {
      "playerName": "默认播放器-红色",
      "playerId": "MDL7ARoayp",
      "date": "2021-04-02 11:53:44",
      "isDefault": 1
    },
    {
      "playerName": "创建的播放器",
      "playerId": "d4b8dDzXsT",
      "date": "2021-03-30 11:38:33",
      "isDefault": 0
    },
    {
      "playerName": "默认播放器",
      "playerId": "1b448be323",
      "date": "2020-09-28 14:17:08",
      "isDefault": 0
    }
  ]
}

異常範例

{
  "code": 400,
  "status": "error",
  "message": "sign can not be empty.",
  "data": ""
}