修改频道角色权限设置
Last updated
Last updated
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
请求体json参数:
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
系统全局错误说明详见全局错误说明
成功示例(测试示例频道号已隐藏)
异常示例
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
参数名 | 类型 | 说明 |
---|---|---|
参数名 | 类型 | 说明 |
---|---|---|
appId
true
String
账号appId【详见获取密钥】
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见签名生成规则】
channelId
true
Integer
频道号
role
true
String
角色类型 Teacher:讲师、Guest:嘉宾
body
true
Object
字幕信息列表【详见body参数字段说明】
webStartCheckInDisplayEnabled
false
String
开播端签到功能显示开关 Y:开启、N:关闭
webStartLotteryDisplayEnabled
false
String
开播端抽奖功能显示开关 Y:开启、N:关闭
webStartQuestionnaireDisplayEnabled
false
String
开播端问卷功能显示开关 Y:开启、N:关闭
webStartAnswerDisplayEnabled
false
String
开播端答题卡功能显示开关 Y:开启、N:关闭
webStartTimerDisplayEnabled
false
String
开播端定时器功能显示开关 (角色类型为讲师时有此字段) Y:开启、N:关闭
webStartRedPackDisplayEnabled
false
String
开播端红包功能显示开关 Y:开启、N:关闭
webStartCardPushDisplayEnabled
false
String
开播端卡片推送功能显示开关 Y:开启、N:关闭
webStartNotifyDisplayEnabled
false
String
开播端公告功能显示开关 Y:开启、N:关闭
webStartLinkMicDisplayEnabled
false
String
开播端连麦功能显示开关 Y:开启、N:关闭
webStartMultiMediaDisplayEnabled
false
String
开播端多媒体功能显示开关 Y:开启、N:关闭
webStartMembersDisplayEnabled
false
String
开播端成员列表功能显示开关 Y:开启、N:关闭
screenShareRetainCameraEnabled
false
String
共享保持摄像头状态开关 Y:开启、N:关闭
multiplexingDefaultLayout
false
String
混流布局默认应用 (角色类型为讲师时有此字段) 1:单人模式、2:平铺模式、3:主讲模式
cameraSingleModeEnabled
false
String
摄像头单人模式开关 Y:开启、N:关闭
aiVirtualBgUrl
false
String
AI抠像背景图
remixDefaultEnabled
false
String
混音默认开关 Y:开启、N:关闭
showSceneTemplateEnabled
false
String
是否显示场景模板开关 Y:开启、N:关闭
hideFramesDirectionEnabled
false
String
隐藏画面方向切换入口开关 Y:开启、N:关闭
defaultOpenMicLinkEnabled
false
String
是连麦默认方式 (角色类型为讲师时可设置此字段) video:音视频、audio:音频
code
Integer
状态码,与 http 状态码相同,用于确定基本的响应状态
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
是否成功响应
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
error
Object
状态码非200时的错误信息【详见Error字段描述】
data
Object
返回内容
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应