查詢頻道重製課件配置資訊

更新時間：2023-06-09 09:08:29

介面描述

1、查询频道重制课件参数设置信息
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

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	頻道號

範例

http://api.polyv.net/live/v3/channel/pptRecord/get-setting?appId=frlr1zazn3&sign=737C622B50A424E007E2CFF0BA68D416&channelId=1965681&timestamp=1629708273547

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或者500的時候，輔助描述錯誤原因
data	Object	回應成功時返回重製課件結果集【詳見data欄位描述】

data欄位描述

參數名	類型	說明
channelId	String	頻道號
userId	String	POLYV使用者ID，和保利威官網一致，取得路徑：官網->登入->直播（開發設定）
type	Integer	影片佈局方式 0：三分螢幕 1：純文件 2：畫中畫
globalSettingEnabled	String	是否使用通用設定 Y：是 N：否
videoRatio	String	攝影機畫面比例 0：畫面比例16:9 1：畫面比例4:3
brandImgFile	String	展示圖片
backgroundImgFile	String	背景圖片
actionPosition	String	重製課件攝影機位置 left：左側 right：右側

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道重制课件配置信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void pptGetSettingTest() 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/pptRecord/get-setting";
    String channelId = "1965681";

    //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": 1965681,
        "userId": "1b448be323",
        "type": 0,
        "globalSettingEnabled": "N",
        "backgroundImg": "http://liveimages.videocc.net/uploadimage/20201126/remakeCoursewareBg_1606386346554_8190198.jpg",
        "videoRatio": "0",
        "brandImg": "",
        "createdTime": 1603155366000,
        "lastModified": 1624506556000,
        "actionPosition": "right"
    }
}

異常範例

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