5API

Example

POST getroom

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

Request

参数

参数名	是否必填	类型	说明
key	是	string	企业Key
serial	否	string	房间编号：选填(该字段和thirdroomid必须至少填写一个)
thirdroomid	否	string	用户自定义房间号：选填(该字段和serial必须至少填写一个)如果用户创建房间时自定义了房间号,可使用此字段

Response

参数名	类型	说明
result	int	返回状态码：0：正常
serial	string	房间号
roomstate	string	房间状态：0：正常
roomtype	string	房间类型：0：1对1；3：1对多
roomname	string	房间名
starttime	string	房间开始时间
endtime	string	房间结束时间
chairmanpwd	string	老师密码
assistantpwd	string	助教密码
confuserpwd	string	学生密码
sidelineuserpwd	string	围观学生密码
thirdroomid	string	用户自定义房间号
patrolpwd	string	巡课密码
maxvideo	string	最大视频数
autoopenaudio	string	上课后自动开启音频：1：自动开启；0：不开启
autoopenvideo	string	上课后自动开启视频：1：自动开启；0：不开启
showYourself	string	只显示老师和自己视频 0：不开启；1：自动开启
ismp4record	int	是否生成mp4 0：否 1：是
isrtmp4record	string	是否实时录制 0：否 1：是
appstudentsshowpage	string	移动端学生视频显示方式，是否翻页显示（每页6路学生视频），0：否，1：是。
roomthemeid	string	教室主题ID
enterurl	string	用户登录链接
rtmp_external_source.push_url	string	直播推流地址
rtmp_external_source.live_id	string	直播推流房间号及密钥
user_microphone	int	用户上台后默认闭麦，0否/1是

ReturnJson

返回示例

{
    "result": 0,
    "serial": "22255919",
    "roomstate": "0",
    "roomtype": "3",
    "roomname": "正式课(80)班-367",
    "starttime": "1623281400",
    "endtime": "1623286200",
    "chairmanpwd": "6688",
    "assistantpwd": "0000",
    "confuserpwd": "",
    "thirdroomid": "",
    "patrolpwd": "1111",
    "maxvideo": "13",
    "autoopenaudio": "1",
    "autoopenvideo": "1",
    "showYourself": "0",
    "appstudentsshowpage": "0",
    "roomthemeid": "1",
    "enterurl": [
        {
            "url": "https://global.talk-cloud.net/enterRoom/22255919/10610/1/0",
            "usertype": 0
        },
        {
            "url": "https://global.talk-cloud.net/enterRoom/22255919/10610/1/0",
            "usertype": 1
        },
        {
            "url": "https://global.talk-cloud.net/enterRoom/22255919/10610/0/2",
            "usertype": 2
        },
        {
            "url": "https://global.talk-cloud.net/enterRoom/22255919/10610/1/0",
            "usertype": 4
        }
    ]
}

错误码说明