获取房间信息

Recent Pages

获取房间信息

最后更新时间：2024-06-12 11:46:26

功能说明
App 管理员可以通过该接口获取房间信息。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/room_engine_http_srv/get_room_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
新加坡：adminapisgp.im.qcloud.com
v4/room_engine_http_srv/get_room_info
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig﻿
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json
最高调用频率
200次/秒。
请求包示例
基础形式
{
  "RoomId": "room-test"
}
请求包字段说明
字段
类型
属性
说明
RoomId
String
必填
房间 ID
应答包体示例
基础形式
{
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ActionStatus": "OK",
  "RequestId": "Id-81fb8ae1529f409a9ed83ef3c3071657-O-Seq-56057",
  "Response": {
      "RoomInfo": {
          "RoomId": "room-test",
          "RoomName": "room-name-test",
          "RoomType": "Conference",
          "Owner_Account": "user2",
          "MaxMemberCount": 300,
          "MaxSeatCount": 16,
          "IsVideoDisabled": true,
          "IsAudioDisabled": true,
          "IsMessageDisabled": true,
          "IsScreenSharingDisabled": true,
          "IsCloudRecordingDisabled": true,
          "CustomInfo": "custom123",
          "ScheduleStartTime": 1703491546,
          "ScheduleEndTime": 1703495146,
          "RoomStatus": "Running",
          "IsSeatEnabled": true,
          "TakeSeatMode": "ApplyToTake",
          "CreateTime": 1703491546,
          "MemberCount": 1
      }
  }
}
应答包字段说明
字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId
RoomId
String
房间 ID
RoomName
String
房间名称
RoomType
String
房间类型：Conference（会议房间）
Owner_Account
String
房主 ID
MaxMemberCount
Integer
最大房间成员数量
ScheduleStartTime
Integer
预定会议开始时间
ScheduleEndTime
Integer
预定会议结束时间
IsVideoDisabled
Bool
全体禁画
IsAudioDisabled
Bool
全体禁音
IsMessageDisabled
Bool
禁止所有成员发文本消息
IsScreenSharingDisabled
Bool
禁止屏幕共享
IsCloudRecordingDisabled
Bool
禁止云录制
CustomInfo
String
自定义信息
RoomStatus
String
房间状态：None（关闭），NotStarted（待开始），Running（进行中）
IsSeatEnabled
Bool
是否支持麦位
MaxSeatCount
Integer
最大麦位数
TakeSeatMode
String
麦位模式：None（关闭），FreeToTake（自由上麦），ApplyToTake（申请上麦）
CreateTime
Integer
预定会议开始时间
MemberCount
Integer
房间成员数量
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试
100002
请参数非法，请根据错误描述检查请求是否正确
100004
房间不存在，或者曾经存在过，但是目前已经被解散
100005
非房间成员
100006
操作权限不足
﻿
﻿

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

获取房间信息

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

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

字段	类型	说明
ActionStatus	String	请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode	Integer	错误码，0表示成功，非0表示失败
ErrorInfo	String	错误信息
RequestId	String	唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId
RoomId	String	房间 ID
RoomName	String	房间名称
RoomType	String	房间类型：Conference（会议房间）
Owner_Account	String	房主 ID
MaxMemberCount	Integer	最大房间成员数量
ScheduleStartTime	Integer	预定会议开始时间
ScheduleEndTime	Integer	预定会议结束时间
IsVideoDisabled	Bool	全体禁画
IsAudioDisabled	Bool	全体禁音
IsMessageDisabled	Bool	禁止所有成员发文本消息
IsScreenSharingDisabled	Bool	禁止屏幕共享
IsCloudRecordingDisabled	Bool	禁止云录制
CustomInfo	String	自定义信息
RoomStatus	String	房间状态：None（关闭），NotStarted（待开始），Running（进行中）
IsSeatEnabled	Bool	是否支持麦位
MaxSeatCount	Integer	最大麦位数
TakeSeatMode	String	麦位模式：None（关闭），FreeToTake（自由上麦），ApplyToTake（申请上麦）
CreateTime	Integer	预定会议开始时间
MemberCount	Integer	房间成员数量

错误码	含义说明
100001	服务器内部错误，请重试
100002	请参数非法，请根据错误描述检查请求是否正确
100004	房间不存在，或者曾经存在过，但是目前已经被解散
100005	非房间成员
100006	操作权限不足

tencent cloud

注册

登录

Recent Pages

获取房间信息

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？