功能说明
管理员可通过该接口查询房间信息。
接口说明
请求URL示列
https://xxxxxx/room_api/v1/roomctl/get/room_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： roomkit.trtc.tencent-cloud.com |
room_api/v1/roomctl/get/room_info | 请求接口 |
sdkappid | 创建应用时控制台分配的 SDKAppID |
identifier | 使用 IM 的管理员账号 |
usersig | |
random | 请输入随机的32位无符号整数，取值范围 0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
{"roomId": "xxx"}
请求包字段说明
字段 | 类型 | 说明 |
roomId | String | 必填。 请求查询的房间唯一标识符 |
响应包字段
{"errorCode": 0,"errorMessage": "Success","requestId": "3fdc344c7a67461c6af3cfc3e77744b5","data": {"roomInfo": {"roomName": "xxx","roomType": 1,"speechMode": 2,"disableVideo": false,"disableAudio": true,"disableMessage": false,"maxSeatCount": 16,"owner" : "test"}"memberCount": 0}}
响应包字段说明
字段 | 类型 | 说明 |
maxSeatCount | Integer | 最大麦位数量，默认为套餐包上限，（直播最大16个 默认16） |
roomName | String | 房间名称 默认房间 ID |
roomType | Integer | 房间类型：1为会议，2为直播 |
speechMode | Bool | 麦控模式：1为自由发言模式，2为举手发言模式，3为就座后发言（抢麦位） |
disableVideo | Bool | 全体禁画 默认 false |
disableAudio | Bool | 全体静音 默认 false |
disableMessage | Bool | 禁止所有成员发送文本消息 默认 false |
memberCount | Integer | 房间成员数量 |
owner | String | 房主 user_id |
错误码说明
错误码 | 含义说明 |
0 | 请求成功 |
84002 | 房间不存在 |
未知错误码 | 未知错误，请联系技术人员 |
可能触发的回调
无。
