即时通信 IM 获取房间信息

功能说明
应用管理员可以通过该接口获取房间信息。
说明：
应用管理员账号可以参见文档 应用管理员 进行配置。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/live_engine_http_srv/get_room_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见  REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
美国：adminapiusa.im.qcloud.com
v4/live_engine_http_srv/get_room_info
获取房间信息接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID，可在即时通信 IM 控制台 的应用卡片中获取。
identifier
账号，必须为应用管理员账号，更多详情请参见 App 管理员。
usersig
应用管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式，固定值为json。
最高调用频率
200次/秒。
请求包示例
基础形式
{
     "RoomId":"live-room"
}
请求包字段说明
字段
类型
属性
说明
RoomId
String
必填
房间 ID。
应答包体示例
基础形式
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720",
  "Response":  {// 响应体
    "RoomInfo" : {
      "RoomId" : "rid-123",
      "RoomName" : "rname-123", 
      "RoomType" : "Live", 
      "Owner_Account" : 144115233775727695,
      "CreateTime": 1693271354,
      "IsSeatEnabled" : true, 
       "TakeSeatMode":"ApplyToTake", 
       "MaxSeatCount" : 8,  
       "MaxMemberCount" : 300, 
       "IsMessageDisabled" : false,   
       "CoverURL": "https://xxxx.png", 
       "Category": [1,2,3], 
       "ActivityStatus":1, 
       "ViewCount":10, 
       "IsPublicVisible": true 
    }
  }
}
应答包字段说明
字段
类型
说明
ActionStatus
String
请求处理的结果。
OK 表示处理成功。
FAIL 表示失败。
ErrorCode
Integer
错误码。
0：表示成功。
非0：表示失败。
ErrorInfo
String
错误信息。
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId。
RoomInfo
Object
房间详情。
RoomId
String
房间 ID。
RoomName
String
房间名称。
RoomType
String
房间类型：Live（直播房间）。
Owner_Account
String
房间 ID。
IsSeatEnabled
Bool
是否开启麦位模式，开启麦位的房间中只有在麦位上的用户才可以开启音视频。
true：开启。
false：未开启。
TakeSeatMode
String
麦位模式。
FreeToTake（自由上麦，无需房主同意可以直接上麦）。
ApplyToTake（申请上麦，上麦申请需房主同意后才可以上麦）。
MaxSeatCount
Integer
麦位数量，受套餐包限制，详见文档 TUILiveKit 能力版本计费说明。
MaxMemberCount
Integer
房间最大人数上限。
IsMessageDisabled
String
房间全员禁言开关。
true： 开启。
false：关闭。
CoverURL
String
房间封面。
Category
Array
直播间分类标签，数组大小上限为3，可以用来作为房间类型标识。
例如游戏、音乐等。
ActivityStatus
Integer
直播间活跃状态：用户自定义的标记。
例如：0：游戏准备中； 1: 游戏中； 2: 游戏结束。
IsPublicVisible
Bool
房间是否公开可见, 用于获取直播间列表使用。
true：公开，可以在直播列表中拉取到该房间。
false：私密，无法在直播列表中拉取到该房间。
CreateTime
Integer
房间创建时间。
ViewCount
Integer
房间观看总次数。
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试。
100002
请参数非法，请根据错误描述检查请求是否正确。
100004
房间不存在，原因可能是房间没被创建过，或者已经被解散了。
接口调试工具
您可以通过 REST API 在线调试工具 调试本接口。

参数	说明
xxxxxx	SDKAppID 所在国家/地区对应的专属域名：中国：`console.tim.qq.com` 新加坡：`adminapisgp.im.qcloud.com` 美国：`adminapiusa.im.qcloud.com`
v4/live_engine_http_srv/get_room_info	获取房间信息接口。
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID，可在即时通信 IM 控制台的应用卡片中获取。
identifier	账号，必须为应用管理员账号，更多详情请参见 App 管理员。
usersig	应用管理员账号生成的签名，具体操作请参见生成 UserSig。
random	请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype	请求格式，固定值为`json`。

字段	类型	说明
ActionStatus	String	请求处理的结果。 OK 表示处理成功。 FAIL 表示失败。
ErrorCode	Integer	错误码。 0：表示成功。非0：表示失败。
ErrorInfo	String	错误信息。
RequestId	String	唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId。
RoomInfo	Object	房间详情。
RoomId	String	房间 ID。
RoomName	String	房间名称。
RoomType	String	房间类型：Live（直播房间）。
Owner_Account	String	房间 ID。
IsSeatEnabled	Bool	是否开启麦位模式，开启麦位的房间中只有在麦位上的用户才可以开启音视频。 true：开启。 false：未开启。
TakeSeatMode	String	麦位模式。 FreeToTake（自由上麦，无需房主同意可以直接上麦）。 ApplyToTake（申请上麦，上麦申请需房主同意后才可以上麦）。
MaxSeatCount	Integer	麦位数量，受套餐包限制，详见文档 TUILiveKit 能力版本计费说明。
MaxMemberCount	Integer	房间最大人数上限。
IsMessageDisabled	String	房间全员禁言开关。 true：开启。 false：关闭。
CoverURL	String	房间封面。
Category	Array	直播间分类标签，数组大小上限为3，可以用来作为房间类型标识。例如游戏、音乐等。
ActivityStatus	Integer	直播间活跃状态：用户自定义的标记。例如：0：游戏准备中； 1: 游戏中； 2: 游戏结束。
IsPublicVisible	Bool	房间是否公开可见, 用于获取直播间列表使用。 true：公开，可以在直播列表中拉取到该房间。 false：私密，无法在直播列表中拉取到该房间。
CreateTime	Integer	房间创建时间。
ViewCount	Integer	房间观看总次数。

错误码	含义说明
100001	服务器内部错误，请重试。
100002	请参数非法，请根据错误描述检查请求是否正确。
100004	房间不存在，原因可能是房间没被创建过，或者已经被解散了。

获取房间信息

本页目录：

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具