修改頻道設定

介面描述

1、修改频道设置
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/update

線上API呼叫

請求方式

POST

介面限制

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

2、研討會（seminar）場景不支援修改：直播觀看模板（template）、無延遲直播開關（pureRtcEnabled）、連麥人數（linkMicLimit）、最大同時線上人數（maxViewer）

3、舊版後台頻道（場景為未定義 newScene：undefined）不支援修改：直播觀看模板（template）

請求參數描述

請求體參數描述

範例

http://api.polyv.net/live/v4/channel/update?appId=frlr1zazn3&sign=B02AEC5A3EA38F7F0506E07E3DC88DB7&channelId=3630700&timestamp=1670551295592

請求體json參數：

{
    "name": "部门宣讲",
    "publisher": "张三",
    "password": "mycAfnC9mkK3lsFc",
    "template": "portrait_ppt",
    "pureRtcEnabled": "Y",
    "linkMicLimit": "16"
}

回應參數描述

Error參數描述

Java請求範例

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

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

private  final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 修改频道设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateChannelTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/update";
    String channelId = "3630700";
    String name = "部门宣讲";
    String password = "mycAfnC9mkK3lsFc";
    String publisher = "张三";
    String template = "portrait_ppt";
    String pureRtcEnabled = "Y";
    String linkMicLimit = "16";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("name", name);
    jsonMap.put("password", password);
    jsonMap.put("publisher", publisher);
    jsonMap.put("template", template);
    jsonMap.put("pureRtcEnabled", pureRtcEnabled);
    jsonMap.put("linkMicLimit", linkMicLimit);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试修改频道设置成功：{}", response);
    //do somethings
    
}

回應範例

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "dc7ae621ef8e4f4a8e4976833f1dbbd4.69.16309852981551185",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360829141876029",
    "error": {
        "code": 30004,
        "desc": "找不到频道"
    },
    "success": false
}