功能说明
管理员可通过该接口创建房间、创建预定会议。
接口说明
请求URL示列
https://xxxxxx/room_api/v1/roomctl/create?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： roomkit.trtc.tencent-cloud.com |
room_api/v1/roomctl/create | 请求接口 |
sdkappid | 创建应用时控制台分配的 SDKAppID |
identifier | 使用 IM 的管理员账号 |
usersig | |
random | 请输入随机的32位无符号整数，取值范围 0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
创建房间。
{"ownerId": "Alice","roomId": "xxx","roomInfo": {"maxSeatCount": 5,"roomName": "Alice's room","roomType": 1,"speechMode": 1,"disableVideo": false,"disableAudio": true,"disableMessage": false,},"scheduleStartTime": 1688528237,"scheduleEndTime": 1688535437}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
ownerId | String | 必填 | 房主 ID |
roomId | String | 必填 | 房间 ID |
maxSeatCount | Integer | 选填 | 最大麦位数量，默认为套餐包上限，（直播最大16个 默认16） |
roomName | String | 选填 | 房间名称。默认为房间 ID |
roomType | Integer | 选填 | 房间类型：1为会议，2为直播 |
speechMode | Integer | 选填 | 麦控模式：1为自由发言模式，2为举手发言模式，3为就座后发言（抢麦位） |
disableVideo | Bool | 选填 | 全体禁画 默认 false |
disableAudio | Bool | 选填 | 全体静音 默认 false |
disableMessage | Bool | 选填 | 禁止所有成员发送文本消息 默认 false |
scheduleStartTime | Integer | 选填 | 预定会议开始时间戳。如果没有设置会议开始时间，则默认为普通房间。（仅会议场景支持） |
scheduleEndTime | Integer | 选填 | 预定会议结束时间戳。如果没有设置会议结束时间，则默认为45分钟，超时房间30s内无人房间会被自动解散。 |
响应包字段
{"errorCode": 0,"errorMessage": "Success","requestId": "3fdc344c7a67461c6af3cfc3e77744b5","data": {"roomInfo": {"roomName": "xxx","roomType": 1,"speechMode": 2,"disableVideo": false,"disableAudio": true,"disableMessage": false,"maxSeatCount": 16},"scheduleStartTime": 1688528237,"scheduleEndTime": 1688535437}}
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 errorCode、errorMessage 来表示的。
公共错误码（70000到79999）请参见 错误码。
错误码 | 含义说明 |
0 | 请求成功 |
84005 | 房间已被使用 |
未知错误码 | 未知错误，请联系技术人员 |
可能触发的回调
创建房间回调。
