创建研讨会频道(新版后台)
旧版接口地址创建单个频道(旧版)
旧版接口升级新版注意事项
1、旧版接口创建频道时,能直接设置频道基本信息、对外研讨时的观看条件 2、新版接口创建频道时,只能设置频道基本信息,观看条件来源于默认模板设置,在创建频道前需设置好默认模板; 3、默认模板的修改不会对已创建的频道产生影响,已创建频道信息的修改与旧版接口一致;
接口描述
接口URL
请求方式
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、研讨会场景下主持人密码和参会人密码不能相同;
请求参数描述
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | true | String | 账号appId【详见获取密钥】 |
timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
sign | true | String | 签名,为32位大写的MD5值, |
请求体参数描述
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
name | true | String | 直播名称,最大长度100 |
newScene | true | String | 直播场景 (seminar-研讨会) |
seminarHostPassword | false | String | 研讨会主持人密码,仅直播场景是研讨会时有效,长度6-16位,不传则由系统随机生成。研讨会主持人密码和参会人密码不能相同。 |
seminarAttendeePassword | false | String | 研讨会参会人密码,仅直播场景是研讨会时有效,长度6-16位,不传则由系统随机生成。研讨会主持人密码和参会人密码不能相同。 |
splashImg | false | String | 封面图片地址,非保利威域名下的图片需调用上传频道所有装修图片素材上传 |
categoryId | false | Integer | 分类ID,可通过“查询直播分类”接口获取 |
startTime | false | Long | 开始时间,时间戳,如:1629734400000 |
subAccount | false | String | 子账号邮箱,填写时频道会创建在该子账号下(子账号不能被删除或者禁用),暂无法通过接口获取 |
linkMicLimit | false | Integer | 参会人数 1-47:代表参会人数 |
示例
请求体json参数:
响应参数描述
参数名 | 类型 | 说明 |
---|---|---|
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请求线程池进行了统一封装和优化。
响应示例
系统全局错误说明详见全局错误说明
成功示例
异常示例
Last updated