取得研討會頻道錄製設定

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

介面描述

1、获取研讨会频道录制设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/seminar/setting/get-record

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/live/v3/channel/seminar/setting/get-record

表單參數：

appId=frlr1zazn3&sign=01556AABE64ED5C285FF5378392FCD8C&channelId=2377623&timestamp=1621840770330

回應參數描述

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

data欄位說明

參數名	類型	說明
enabled	String	錄製開關，Y開啟、N關閉
recordMode	String	錄製模式，auto自動、manual手動

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(RecordSettingTest.class);
/**
 * 获取研讨会频道录制设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testRecordSetting() 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/v3/channel/seminar/setting/get-record";
    String channelId = "2377623";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试获取研讨会频道录制设置返回值：{}",response);
    //do somethings
    
}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "channelId": 2191532,
    "userId": "1b448be323",
    "enabled": "Y",
    "mode": "auto",
    "period": "hostOnline",
    "resolution": "720p",
    "createdTime": 1628133221000,
    "lastModified": 1628133221000
  }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}