更新房间信息

最近更新时间:2023-12-19 14:26:53

我的收藏

功能说明

管理员可通过该接口更新房间信息。

接口说明

请求URL示列

https://xxxxxx/room_api/v1/roomctl/update/room_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:roomkit.trtc.tencent-cloud.com
room_api/v1/roomctl/update
请求接口
sdkappid
创建应用时控制台分配的 SDKAppID
identifier
使用 IM 的管理员账号
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
"roomId": "xxx",
"maxSeatCount": 5,
"roomName": "Alice's room",
"speechMode": 1,
"disableVideo": false,
"disableAudio": true,
"disableMessage": false,
"scheduleStartTime": 1688528237,
"scheduleEndTime": 1688535437
}

请求包字段说明

字段
类型
属性
说明
roomId
String
必填
房间 ID
maxSeatCount
Integer
选填
最大麦位数量,默认为套餐包上限,(直播最大16个 默认16)
roomName
String
选填
房间名称。默认房间为 ID
speechMode
Integer
选填
麦控模式:1为自由发言模式,2为举手发言模式,3为就座后发言(抢麦位)
默认为:自由发言模式1,具体请参见:发言模式
disableVideo
Bool
选填
全体禁画 默认 false
disableAudio
Bool
选填
全体静音 默认 false
disableMessage
Bool
选填
禁止所有成员发送文本消息 默认 false
scheduleStartTime
Integer
选填
预定会议开始时间
scheduleEndTime
Integer
选填
预定会议结束时间

响应包字段

{
"errorCode": 0,
"errorMessage": "Success",
"requestId": "3fdc344c7a67461c6af3cfc3e77744b5",
"data": {
"roomInfo": {
"roomName": "xxx",
"roomType": 1,
"speechMode": 2,
"disableVideo": false,
"disableAudio": true,
"disableMessage": false,
"maxSeatCount": 16,
"scheduleStartTime": 1689071761,
"scheduleEndTime": 1689074461
}
}
}

错误码说明

错误码
含义说明
0
请求成功
84002
房间不存在
未知错误码
未知错误,请联系技术人员

可能触发的回调

更新房间信息回调。