更新頻道重製課件設定

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

介面描述

1、更新频道重制课件设置
2、接口支持https协议

介面URL

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

請求方式

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	頻道ID
globalSettingEnabled	false	String	是否使用通用設定，Y是，N否
type	false	Integer	影片佈局方式，0.三分屏、1.純文件
videoRatio	false	Integer	攝影機畫面比例，新版重製有效，預設0，0表示16:9、1表示4:3
brandImgFile	false	File	展示圖片，新版重製有效，攝影機畫面比例為16:9時尺寸為480X810，攝影機畫面比例為4:3時尺寸為480X720，支援jpg和png格式
backgroundImgFile	false	File	背景圖片，舊版重製有效，尺寸為1280X720，支援jpg和png格式

範例

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

表單參數：

appId=fso8gzbxlr&timestamp=1628074098000&channelId=1947328&globalSettingEnabled=N&type=0&videoRatio=0&sign=FB1357F4199FF7838A158D6BE25791C5

回應參數描述

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

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 testUpdateSetting() 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/pptRecord/setting";
    String channelId="1947328";
    String globalSettingEnabled = "N";
    String type = "0";
    String videoRatio = "0";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("globalSettingEnabled", globalSettingEnabled);
    requestMap.put("type", type);
    requestMap.put("videoRatio", videoRatio);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("更新频道重制课件设置，返回值：{}", response);
    //do somethings

}

回應範例

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

成功範例

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

異常範例

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