Docs Overview/
Conference/
Web/
服务器 API/
REST 接口/
Room Management/
Create a Room/

Create a Room

功能说明

App 管理员可以通过该接口创建房间、创建预定会议。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/room_engine_http_srv/create_room?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
新加坡：adminapisgp.im.qcloud.com
v4/room_engine_http_srv/create_room
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式
{
  "RoomInfo":{
      "RoomId": "room-test",
      "RoomName": "room-name-test",
      "RoomType": "Conference",
      "Owner_Account": "user2",
      "MaxMemberCount": 300,
      "ScheduleStartTime" : 1693271355,
      "ScheduleEndTime" : 1693272355,
      "IsVideoDisabled": true,
      "IsAudioDisabled": true,
      "IsMessageDisabled": true,
      "IsScreenSharingDisabled": true,
      "IsCloudRecordingDisabled": true,
      "CustomInfo": "custom123",
      "IsSeatEnabled": true,
      "MaxSeatCount": 16,
      "TakeSeatMode": "ApplyToTake"
  },
  "ScheduleInviteeList_Account":[
      "user1", "user2", "user3"
  ]
}

请求包字段说明

字段
类型
属性
说明
RoomId
String
必填
房间 ID，最长48个字节
RoomName
String
选填
房间名称，默认为房间 ID，最长100个字节
RoomType
String
必填
房间类型：Conference（会议房间）
Owner_Account
String
选填
房主 ID（需是 已导入 的账号），默认为接口调用者的用户 ID
MaxMemberCount
Integer
选填
最大房间成员数量，缺省时的默认值：付费套餐包上限，例如体验版是20，如果升级套餐包，需按照修改房间资料修改这个字段
ScheduleStartTime
Integer
选填
预定会议开始时间，默认为当前时间
ScheduleEndTime
Integer
选填
预定会议结束时间，默认为开始时间后1小时，会议最小时间不得低于5分钟，最长时间不得超过24h
IsVideoDisabled
Bool
选填
全体禁画，默认 false
IsAudioDisabled
Bool
选填
全体禁音，默认 false
IsMessageDisabled
Bool
选填
禁止所有成员发文本消息，默认 false
IsScreenSharingDisabled
Bool
选填
禁止屏幕共享，默认 false
IsCloudRecordingDisabled
Bool
选填
禁止云录制，默认 false
CustomInfo
String
选填
自定义信息，最长500个字节
IsSeatEnabled
Bool
选填
是否支持麦位，默认不支持
MaxSeatCount
Integer
选填
最大麦位数，默认为套餐包上限（默认最大20）
TakeSeatMode
String
选填
麦位模式：FreeToTake（自由上麦），ApplyToTake（申请上麦）
ScheduleInviteeList_Account
Array
选填
预约成员列表，最多300个
注意：
用户需要在会议结束以后，手动调用 解散房间 接口，结束本场会议。
如果没有手动调用解散房间接口，后台会在会议结束时间6小时以后，尝试回收房间，回收的条件是房间内成员数为0。

应答包体示例

基础形式
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试
100002
请参数非法，请根据错误描述检查请求是否正确
100003
房间 ID 已存在，请选择其他房间 ID
100007
无付费信息，需在控制台购买套餐包
100010
房间 ID 已被使用，并且操作者为房主，可以直接使用
100011
房间 ID 已被 IM 占用，可以换一个房间 ID 使用，或者先通过 IM 接口解散该群
100012
创建房间超过频率超限，同一房间 ID 1秒内只能创建一次

可能触发的回调

创建房间之后回调