ListWaitLinkAudience - 获取申请连麦观众列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListWaitLinkAudience - 获取申请连麦观众列表

最近更新时间：2025.03.24 16:50:59首次发布时间：2024.11.27 10:45:52

您可通过此接口获取指定直播间中，已申请连麦但上麦申请尚未通过的观众列表。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=ListWaitLinkAudience&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListWaitLinkAudience`	接口名称。当前 API 的名称为 `ListWaitLinkAudience`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1772****30705`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
PageNo	Integer	否	`1`	分页查询页码。默认值为 1。取值范围为 [1,1000]。说明接口最多支持返回 1000 条查询结果，即 `PageNo` × `PageItemCount` ≤ 1000。
PageItemCount	Integer	否	`2`	分页查询数量。默认值为 100。取值范围为 [1,1000]。说明接口最多支持返回 1000 条查询结果，即 `PageNo` × `PageItemCount` ≤ 1000。

返回参数

参数	类型	示例值	描述
PageNo	Integer	`1`	分页查询页码。
PageItemCount	Integer	`2`	分页查询数量。
TotalCount	Integer	`1000`	查询结果总数。
AudienceList	Array of AudienceList	`-`	申请连麦的观众列表。

AudienceList

参数	类型	示例值	描述
UserId	Long	`181539****678618`	用户 ID。
Nickname	String	`观众 A`	昵称。
IsLinking	Integer	`0`	连麦状态。取值固定为 `0`（正在申请连麦中）。
CreateTime	Long	`1731296972282`	申请连麦的时间。Unix 时间戳，单位为毫秒。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListWaitLinkAudience&Version=2023-08-01&ActivityId=1772****30705&PageNo=1&PageItemCount=2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListWaitLinkAudience",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1731563967
    },
    "Result": {
        "AudienceList": [
            {
                "UserId": 181539****678618,
                "Nickname": "观众 A",
                "IsLinking": 0,
                "CreateTime": 1731296972282
            },
            {
                "UserId": 181539****678619,
                "Nickname": "观众 B",
                "IsLinking": 0,
                "CreateTime": 1731296972283
            }
        ],
        "PageNo": 1,
        "PageItemCount": 2,
        "TotalCount": 1000
    }
}

错误码

访问公共错误码和错误码获取详细信息。