调用ListRoomUsers查询房间用户列表-阿里云帮助中心

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	用户的应用ID，在控制台创建应用时生成。包含小写字母、数字，长度为6个字符。	7m***q
PageNumber	integer	否	查询页码，从1开始，传空默认查询第1页。	1
PageSize	integer	否	每页显示个数，最大支持100，参数为空默认显示个数为50。	10
RoomId	string	是	房间ID，由字母、数字、下划线（_）和小数点（.）组成，最大长度36个字符。	AE35-****-T95F

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求ID。	FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Result	object	分页查询房间用户列表返回的结果。
TotalCount	integer	房间内的用户总数。	1000
PageTotal	integer	房间内的用户总页数。	100
HasMore	boolean	是否还有下一页用户列表。	true
RoomUserList	array	房间用户列表信息。
	object
UserId	string	用户唯一标识。	as****hs
Nick	string	用户昵称。	User001
Extension	object	用户扩展字段。
	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>

错误码

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