首页 >低代码音视频工厂 >API参考 >服务端API >API目录 >房间 >ListRoomUsers - 查询房间用户列表

ListRoomUsers - 查询房间用户列表

调用ListRoomUsers分页查询房间内的实时用户列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
PageNumberinteger

查询页码,从1开始,传空默认查询第1页。

1
PageSizeinteger

每页显示个数,最大支持100,参数为空默认显示个数为50。

10
RoomIdstring

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

AE35-****-T95F

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

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

分页查询房间用户列表返回的结果。

TotalCountinteger

房间内的用户总数。

1000
PageTotalinteger

房间内的用户总页数。

100
HasMoreboolean

是否还有下一页用户列表。

true
RoomUserListarray

房间用户列表信息。

object
UserIdstring

用户唯一标识。

as****hs
Nickstring

用户昵称。

User001
Extensionobject

用户扩展字段。

string

用户扩展信息。

test001

示例

请求示例

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

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "TotalCount": 1000,
        "PageTotal": 100,
        "HasMore": true,
        "RoomUserList": [
            {
                "UserId": "as****hs",
                "Nick": "User001",
                "Extension": {
                    "key": "test001"
                }
            }
        ]
    }
}

XML格式

<ListRoomUsersResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <TotalCount>1000</TotalCount>
        <PageTotal>100</PageTotal>
        <HasMore>true</HasMore>
        <RoomUserList>
            <UserId>as****hs</UserId>
            <Nick>User001</Nick>
            <Extension>
                <key>test001</key>
            </Extension>
        </RoomUserList>
    </Result>
</ListRoomUsersResponse>

错误码

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

阿里云首页 低代码音视频工厂 相关技术圈