修改频道设置

接口描述

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）

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号

请求体参数描述

参数名	必选	类型	说明
name	false	String	直播名称，最大长度100
password	false	String	密码，长度6~16位，需同时包含数字与字母
seminarHostPassword	false	String	主持人密码，频道场景为研讨会有效，长度6~16位，需同时包含数字与字母
seminarAttendeePassword	false	String	参会人密码，频道场景为研讨会有效，长度6~16位，需同时包含数字与字母
publisher	false	String	主持人，最大长度100
template	false	String	直播观看模板 三分屏-横屏：ppt 三分屏-竖屏：portrait_ppt 纯视频-横屏：alone 纯视频-竖屏：portrait_alone 纯视频-极速-横屏：topclass 纯视频-极速-竖屏：portrait_topclass 旧版后台频道（场景为未定义 newScene：undefined）不支持修改 研讨会（seminar）场景不支持修改 场景为三分屏（scene：ppt）可修改值：ppt、portrait_ppt 场景为纯视频（scene：alone）可修改值：alone、portrait_alone 场景为大班课（scene：topclass）可修改值：topclass、portrait_topclass
pureRtcEnabled	false	String	无延时直播开关 Y：开启 N：关闭
linkMicLimit	false	Integer	连麦人数，范围：0-16
maxViewer	false	Integer	最大同时在线人数
resetStartTime	false	String	清空开始时间, Y是、N否 (当为Y时startTime字段需要为空或者不传)
startTime	false	Long	直播开始时间，13位毫秒级时间戳，需大于当前时间
endTime	false	Long	直播结束时间，13位毫秒级时间戳，需大于直播开始时间
splashImg	false	String	引导页图片地址，非保利威域名下的图片需先调用上传频道所有装修图片素材上传
clientAloneTemplateBackgroundUrl	false	String	客户端模版背景图URL
liveCdnBackgroundUrl	false	String	视频混流背景图URL

示例

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"
}

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	响应结果，由业务决定，成功返回true，失败返回false
data	Object	成功或失败均返回null
error	Object	状态码非200时的错误信息【详见Error字段说明】
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

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
}