保利威文档中心

帮助中心

直播服务端 API

修改频道直播模版

更新时间：2025-09-16 16:19:59

接口描述

1、修改频道直播模板信息
2、接口支持https协议

接口URL

https://api.polyv.net/live/v4/channel/update-template

在线API调用

请求方式

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
template true String 频道直播模板，取值详细参考“频道直播模板template 取值说明”

频道直播模板template 取值说明

取值 说明
alone 纯视频+横屏 模式
ppt 文档+视频(三分屏)+横屏 模式
portrait_alone 纯视频+竖屏 模式
portrait_ppt 文档+视频(三分屏)+竖屏 模式
topclass 纯视频-极速(原大班课)+横屏 模式
portrait_topclass 纯视频-极速(原大班课)+竖屏屏 模式

示例

http://api.polyv.net/live/v4/channel/update-template?appId=frlr1zazn3&sign=417802BACAD3375E72CA1A53848E0A53&channelId=2824409&timestamp=1648779734640&template=alone

响应参数描述

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

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 updateTemplate() 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-template";
    String channelId = "2824409";
    String template = "alone";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("template", template);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.post(url,requestMap);
    log.info("测试修改频道直播模板成功：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
  "code": 200,
  "status": "success",
  "requestId": "0a57e87d-e2a8-4786-bf1e-1bcfbc96a3e5",
  "data": null,
  "success": true
}

异常示例

{
  "code": 400,
  "status": "error",
  "requestId": "66b7b98c-670b-4b50-9b8e-a3b4152e3635",
  "error": {
    "code": 30029,
    "desc": "非法直播模板"
  },
  "data": null,
  "success": false
}
联系客服，在线咨询