1API

Example

POST roomcreate

https://global.talk-cloud.net/WebAPI/roomcreate

参数

参数名 是否必填 类型 说明
key String 企业Key
roomname String 房间名:如果有中文请使用UTF8编码,特殊字符需使用urlencode 转义
roomtype Int 房间类型:0:1对1;3:1对多 6:微录客 7:超级大班课(需要系统管理员开启)
starttime Int 房间开始时间:(UTC时间戳,精确到秒), 例:1429242959
endtime Int 房间结束时间:(UTC时间戳,精确到秒), 例:1429242959
chairmanpwd String 老师密码:4=<长度<=16旁听生学生助教巡课老师各个身份密码不能相同
assistantpwd String 助教密码:4=<长度<=16旁听生学生助教巡课老师各个身份密码不能相同
patrolpwd String 巡课密码:4=<长度<=16旁听生学生助教巡课老师各个身份密码不能相同
passwordrequired Int 学生进入房间是否需要:0:否;1:是
confuserpwd String 学生密码:passwordrequired = 1 时必填(4 位以上)或者allowsidelineuser = 1 时必填,旁听生学生助教巡课老师各个身份密码不能相同
auditorsrequired Int 旁听生进入房间是否需要密码:0:否;1:是
auditorspwd String 旁听生:auditorsrequired = 1 时必填(4 位以上) 直播课不允许旁听生进入,旁听生学生助教巡课老师各个身份密码不能相同
videotype Int 视频分辨率:0:240x180;1:320x240;2:640x480;3:1280x720 ;4:1920x1080;6: 960x540;7: 640x360;8: 320x180;9:160x120;11:960x720
videoframerate Int 视频帧率:10,15,20,25,30
autoopenaudio Int 上课后自动开启音频:0:不开启;1:自动开启 roomtype=7时类型忽略传值默认不开启
autoopenvideo Int 上课后自动开启视频:0:不开启;1:自动开启 roomtype=7时类型忽略传值默认不开启
ismp4record Int 是否录制mp4:0:不录制;1:录制(roomtype=7时不生效)
isrtmp4record Int 教室是否实时mp4录制:0:不实时;1:实时(此当参数ismp4record为1时或不传,才可以设置此参数为1)
roomlayout Int 教室布局。一对多教室布局:1视频置顶(默认)/2视频置底/3视频居右/4主讲居右/6主讲视频/7自由视频/10视频居左(4.1.1.X版本以上以上适用)/11主讲居左(4.1.1.X版本以上以上适用); 一对一教室布局:51视频居右(默认)/52双师布局/53视频布局/54视频居左(3.6.0版本以上适用); 超级大班课教室布局:3视频居右(默认)/8课件全屏布局/9视频全屏布局/12视频居左 /13(1v1)伪上台布局
toplimit Int 设置学生人数上限 (不建议用)
support_connection Int 是否支持连麦(roomtype=7时支持): 0不支持,1支持
openanalyze Int 是否开启学情分析(1开启2不开启;企业开启了此配置,传1开启才会生效;如果企业开启了,此参数没有传,则默认开启)
isOpenRecordSegment Int 是否开启精彩片段 0不开启 1开启 默认值 :0
tea_dual_cameras Int 老师双摄 0:不使用,1:使用。默认值:0 支持:一对一、一对多、大班课。支持布局:一对一:视频置顶、视频置底。一对多:视频置顶、视频置底。大班课:视频居右、视频居左
stu_dual_cameras int 学生双摄 0:不使用,1:使用。默认值:0 支持:一对一、一对多、大班课。支持布局:一对一:视频置顶、视频置底。一对多:视频置顶、视频置底。大班课:视频居右、视频居左
appstudentsshowpage int 移动端学生视频显示方式,是否翻页显示(每页6路学生视频),0:否,1:是。(不传此参数使用企业默认设置的,仅当对应配置开启时生效)
classlogourl String 教室logo链接地址(字符不能超过128)
roomthemeid Int 教室主题ID,可通过接口/WebAPI/getRoomThemeList获取
group Int 是否开启分组 0不开启 1开启 分组 后台开启分组配置项 该参数才能生效 只能在一对多教室中使用 该参数不能和老师双摄,学生双摄,只显示老师和自己视频参数不能同时使用
rtmp_pushurl String rtmp转推地址(字符不能超过256) (需要联系商务开通“支持rtmp推流”配置项)
introduction String 直播简介(roomtype=7时支持)
live_pull_type Int 直播延迟类型(roomtype=7时支持),默认0普通直播≈3秒,1快直播≈1秒(收费与普通直播不同)
rtmp_external_source Int 是否使用外部媒体源 0:否 1:是
open_uploadfile Int 是否开启教室内上传课件功能 0:否 1:是 默认:1
subtitle Int 付费功能:是否开启字幕功能 0:否 1:是 默认:0 支持版本:4.11.4以上(含4.11.4)
tea_subtitle_language Int 付费功能:老师讲课口语。默认:zh-CN(中文简体)支持语种见:支持语种列表
stu_subtitle Int 付费功能:学生字幕语种 1:语音翻译 2:语音识别 默认:1
user_microphone Int 用户上台后默认闭麦,0否(默认)/1是,仅限超级大班课有效
screen String 是否开启监课截图 0:不开启 1:开启 默认:1 需联系超管开启该功能
virtual_bg_id Int 虚拟背景ID
rewardtitle_group_id Int 称号组ID(通过接口/WebAPI/rewardTitleGroup获取)
watermark_id Int 水印ID(可通过接口/WebAPI/watermarkList获取)
thirdroomid String 用户自定义房间号:选填如果用户创建房间时自定义了房间号,可使用此字段
参数名 类型 说明
result int 返回状态码:0:正常
serial String 房间号

返回示例

1
2
3
4
  {
    "result": 0,
    "serial": 123123132
  }

© 2016-2023 北京拓课网络科技有限公司 版权所有  京ICP备17018423号-1 京公网安备11010502043461号