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

ListConferenceUsers - 查询连麦用户列表

调用ListConferenceUsers分页查询连麦用户信息。

调试

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

调试

授权信息

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

请求参数

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

连麦唯一标识。由字母、数字和短横线(-)组成,长度为36个字符。

fb0f-****-4cb1
PageNumberinteger

查询页码,从第1页开始。

1
PageSizeinteger

每页显示个数,最大支持100。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

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

分页查询连麦用户信息的返回结果。

true
ConferenceUserListarray

连麦用户列表。

myApp
object
UserIdstring

用户ID。

4*****9
Statusstring

用户状态。取值:

  • Init:初始状态。

  • OnJoining:呼叫中。

  • Active:连麦中。

  • JoinFail:连麦失败。

  • Kicked:被踢出。

  • Leave:离开连麦。

active
HasMoreboolean

是否还有数据。

true
TotalCountinteger

总条目数。

100
PageTotalinteger

总页数。

100

示例

请求示例

http(s)://[Endpoint]/?Action=ListConferenceUsers
&ConferenceId=fb0f-****-4cb1
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "ConferenceUserList": [
            {
                "UserId": "4*****9",
                "Status": "active"
            }
        ],
        "HasMore": true,
        "TotalCount": 100,
        "PageTotal": 100
    }
}

XML格式

<ListConferenceUsersResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <ConferenceUserList>
            <UserId>4*****9</UserId>
            <Status>active</Status>
        </ConferenceUserList>
        <HasMore>true</HasMore>
        <TotalCount>100</TotalCount>
        <PageTotal>100</PageTotal>
    </Result>
</ListConferenceUsersResponse>

错误码

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

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