6API
Example
POST roommodify
https://global.talk-cloud.net/WebAPI/roommodify
参数
| 参数名 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| key | 是 | text | 企业Key |
| serial | 否 | text | 房间编号:选填(该字段和thirdroomid必须至少填写一个) |
| roomname | 否 | text | 房间名:如果有中文请使用UTF8编码,特殊字符需使用urlencode 转义 |
| starttime | 否 | Int | 房间开始时间:(UTC时间戳,精确到秒), 例:1429242959 |
| endtime | 否 | Int | 房间结束时间:(UTC时间戳,精确到秒), 例:1429242959 |
| chairmanpwd | 否 | text | 老师密码:4=<长度<=16 |
| assistantpwd | 否 | text | 助教密码:4=<长度<=16 |
| patrolpwd | 否 | text | 巡课密码:4=<长度<=16 |
| passwordrequired | 否 | Int | 学生进入房间是否需要:0:否;1:是 |
| confuserpwd | 否 | text | 学生密码:passwordrequired = 1 时必填(4 位以上)或者allowsidelineuser = 1 时必填 |
| 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 | 否 | text | 是否录制mp4:0:不录制;1:录制 (roomtype=7时不生效) |
| isrtmp4record | 否 | Int | 教室是否实时mp4录制:0:不实时;1:实时(此当参数ismp4record为1时或不传,才可以设置此参数为1) |
| maxvideo | 否 | text | 最大视频数:默认取企业的(注:不能大于企业最大数) |
| vcodec | 否 | Int | h264硬件编码:0:不勾选;2:勾选 |
| 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视频居左 |
| toplimit | 否 | Int | 无 |
| support_connection | 否 | Int | 是否支持连麦(roomtype=7时支持): 0不支持,1支持 |
| openanalyze | 否 | Int | 是否开启学情分析(1开启2不开启;企业开启了此配置,传1开启才会生效;如果企业开启了,此参数没有传,则默认开启) |
| isOpenRecordSegment | 否 | Int | 是否开启精彩片段 0不开启 1开启 默认值 :0 |
| appstudentsshowpage | 否 | Int | 移动端学生视频显示方式,是否翻页显示(每页6路学生视频),0:否,1:是。(不传此参数默认使用以前设置的,对应配置开启时生效,对应配置关闭时且以往对应参数值为1时生效) |
| classroomlogo | 否 | file | 上传教室logo,不上传则使用修改前设置的教室logo |
| usecompany_roomlogo | 否 | Int | 使用企业设置的默认教室logo,0否/1是,classroomlogo有上传文件时无效 |
| roomthemeid | 否 | Int | 教室主题ID,可通过接口/WebAPI/getRoomThemeList获取 |
| 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 | 否 | text | 用户自定义房间号:选填(该字段和serial必须至少填写一个)如果用户创建房间时自定义了房间号,可使用此字段 |
| 参数名 | 类型 | 说明 |
|---|---|---|
| result | int | 返回状态码:0:正常 |
| serial | String | 房间号 |
返回示例
1 2 3 4 | |




