Modify Channel Settings

Interface Description

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

Interface URL

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

Online API Call

Request Method

POST

Interface Constraints

1. The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

2. The seminar scenario does not support modifying: live viewing template (template), low-latency live streaming switch (pureRtcEnabled), number of link mic users (linkMicLimit), maximum concurrent viewers (maxViewer)

3. Legacy backend channels (scenario undefined newScene: undefined) do not support modifying: live viewing template (template)

Request Parameter Description

Request Body Parameter Description

Example

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

Request body JSON parameters:

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

Response Parameter Description

Error Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

Success Example

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

Error Example

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