https://xxxxxx/v4/room_engine_http_srv/create_room?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 新加坡: adminapisgp.im.qcloud.com |
v4/room_engine_http_srv/create_room | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
{"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 | 选填 | |
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个 |
{"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 |
错误码 | 含义说明 |
100001 | 服务器内部错误,请重试 |
100002 | 请参数非法,请根据错误描述检查请求是否正确 |
100003 | 房间 ID 已存在,请选择其他房间 ID |
100007 | 无付费信息,需在控制台购买套餐包 |
100010 | 房间 ID 已被使用,并且操作者为房主,可以直接使用 |
100011 | 房间 ID 已被 IM 占用,可以换一个房间 ID 使用,或者先通过 IM 接口解散该群 |
100012 | 创建房间超过频率超限,同一房间 ID 1秒内只能创建一次 |
本页内容是否解决了您的问题?