文档

GetRoom - 查询房间详情

更新时间:

调用GetRoom查询指定房间信息,包含房间信息和使用中的原子能力信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imp:GetRoomRead
  • IMP
    acs:imp::{#accountId}:*

请求参数

名称类型必填描述示例值
AppIdstring

应用唯一标识,可以包含小写字母、数字,长度为6个字符。

7m***q
RoomIdstring

房间ID,由字母、数字、小数点(.)和短横线(-)组成,最大长度36个字符。

AE35-****-T95F

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

查询房间的返回结果。

RoomInfoobject

房间信息。

RoomIdstring

房间唯一标识。

AE35-****-T95F
Titlestring

房间标题。

RoomTitle001
CreateTimeLong

房间创建时间戳,单位:毫秒。

1624589848000
Noticestring

房间公告。

RoomNotice001
RoomOwnerIdstring

房主用户ID。

as****hs
UvLong

访问用户数。

100
OnlineCountLong

在线用户数。

50
PluginInstanceInfoListarray

活跃插件列表。

object
PluginTypestring

插件唯一标识,取值:

  • live:直播。
  • wb:白板。
  • chat:聊天。
  • RTC:音视频通信。
live
PluginIdstring

插件实例唯一标识。

HASU-****-ASHD
CreateTimeLong

插件实例创建时间戳,单位:毫秒。

1624589848000
Extensionobject

插件拓展字段。

string

插件拓展信息。

test001
AppIdstring

应用唯一标识,可以包含小写字母、数字,长度为6个字符。

lq****cu
TemplateIdstring

创建房间使用的模板ID。

default
Extensionobject

房间拓展字段。

string

房间拓展信息。

test001
PvLong

访问用户人次。

200
AdminIdListarray

管理员ID列表。

string

管理员ID。

as****hs

示例

请求示例

http(s)://[Endpoint]/?Action=GetRoom
&AppId=7m***q
&RoomId=AE35-****-T95F
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "RoomInfo": {
            "RoomId": "AE35-****-T95F",
            "Title": "RoomTitle001",
            "CreateTime": 1624589848000,
            "Notice": "RoomNotice001",
            "RoomOwnerId": "as****hs",
            "Uv": 100,
            "OnlineCount": 50,
            "PluginInstanceInfoList": [
                {
                    "PluginType": "live",
                    "PluginId": "HASU-****-ASHD",
                    "CreateTime": 1624589848000,
                    "Extension": {
                        "key": "test001"
                    }
                }
            ],
            "AppId": "lq****cu",
            "TemplateId": "default",
            "Extension": {
                "key": "test001"
            },
            "Pv": 200,
            "AdminIdList": [
                "as****hs"
            ]
        }
    }
}

XML格式

<GetRoomResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <RoomInfo>
            <RoomId>AE35-****-T95F</RoomId>
            <Title>RoomTitle001</Title>
            <CreateTime>1624589848000</CreateTime>
            <Notice>RoomNotice001</Notice>
            <RoomOwnerId>as****hs</RoomOwnerId>
            <Uv>100</Uv>
            <OnlineCount>50</OnlineCount>
            <PluginInstanceInfoList>
                <PluginType>live</PluginType>
                <PluginId>HASU-****-ASHD</PluginId>
                <CreateTime>1624589848000</CreateTime>
                <Extension>
                    <key>test001</key>
                </Extension>
            </PluginInstanceInfoList>
            <AppId>lq****cu</AppId>
            <TemplateId>default</TemplateId>
            <Extension>
                <key>test001</key>
            </Extension>
            <Pv>200</Pv>
            <AdminIdList>as****hs</AdminIdList>
        </RoomInfo>
    </Result>
</GetRoomResponse>

错误码

Http code错误码错误信息描述
400InvalidRoomId.Room.NotExistRoom does not exist.房间不存在,请检查。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈