创建研讨会频道(新版后台)
更新时间:2026-04-09 17:41:40
旧版接口地址创建单个频道(旧版)
旧版接口升级新版注意事项
1、旧版接口创建频道时,能直接设置频道基本信息、对外研讨时的观看条件
2、新版接口创建频道时,只能设置频道基本信息,观看条件来源于默认模板设置,在创建频道前需设置好默认模板;
3、默认模板的修改不会对已创建的频道产生影响,已创建频道信息的修改与旧版接口一致;
接口描述
1、根据直播默认模板创建频道
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
接口URL
http://api.polyv.net/live/v4/channel/create
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、研讨会场景下主持人密码和参会人密码不能相同;
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
请求体参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| name | true | String | 直播名称,最大长度100 |
| newScene | true | String | 直播场景 (seminar-研讨会) |
| seminarHostPassword | false | String | 研讨会主持人密码,仅直播场景是研讨会时有效,长度6-16位,不传则由系统随机生成。研讨会主持人密码和参会人密码不能相同。 |
| seminarAttendeePassword | false | String | 研讨会参会人密码,仅直播场景是研讨会时有效,长度6-16位,不传则由系统随机生成。研讨会主持人密码和参会人密码不能相同。 |
| recordMode | false | String | 录制方式,仅直播场景是研讨会时有效。auto 自动录制(默认);manual 手动录制 |
| seminarLiveType | false | String | 会议类型,仅直播场景是研讨会时有效。private 对内研讨(默认);public 对外直播 |
| splashImg | false | String | 封面图片地址,非保利威域名下的图片需调用上传频道所有装修图片素材上传 |
| categoryId | false | Integer | 分类ID,可通过“查询直播分类”接口获取 |
| startTime | false | Long | 开始时间,时间戳,如:1629734400000 |
| subAccount | false | String | 子账号邮箱,填写时频道会创建在该子账号下(子账号不能被删除或者禁用),暂无法通过接口获取 |
| linkMicLimit | false | Integer | 参会人数 1-47:代表参会人数 |
示例
http://api.polyv.net/live/v4/channel/create?appId=frlr1zazn3&sign=E3F501CFEF5FCCF2DF9BFDCE9C91F48C×tamp=1629445373947
请求体json参数:
{
"name": "polyv研讨会",
"newScene": "seminar",
"recordMode": "auto",
"seminarLiveType": "private",
"seminarHostPassword": "hostpasswd",
"seminarAttendeePassword": "attendeepasswd"
}
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| data | Object | 频道响应对象【详见data字段说明】 |
| error | Object | 错误信息【详见data字段说明】 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | Integer | 频道ID |
| userId | String | POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置) |
| channelPasswd | String | 讲师登录密码,直播场景不是研讨会时不为null,长度6-16位 |
| seminarHostPassword | String | 研讨会主持人密码,仅直播场景是研讨会时不为null,长度6-16位 |
| seminarAttendeePassword | String | 研讨会参会人密码,仅直播场景是研讨会时不为null,长度6-16位 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
/**
* 创建研讨会频道
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testBasicCreateV4() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/channel/create";
String name = "polyv研讨会";
String newScene = "seminar";
String recordMode = "auto";
String seminarLiveType = "private";
String seminarHostPassword = "hostpasswd";
String seminarAttendeePassword = "attendeepasswd";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
Map<String, String> bodyMap = new HashMap<>();
bodyMap.put("name", name);
bodyMap.put("newScene", newScene);
bodyMap.put("recordMode", recordMode);
bodyMap.put("seminarLiveType", seminarLiveType);
bodyMap.put("seminarHostPassword", seminarHostPassword);
bodyMap.put("seminarAttendeePassword", seminarAttendeePassword);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String body = JSON.toJSONString(bodyMap);
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url,body,null);
log.info("测试创建研讨会频道,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "788bc586bbe34965a15a284c511116df.66.16414529932010715",
"data": {
"channelId": 2771673,
"userId": "1b448be323",
"scene": null,
"channelPasswd": null,
"seminarHostPassword": "hostpasswd",
"seminarAttendeePassword": "attendeepasswd"
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
