GetRealTimeOnlineNumberAPI - 获取直播间在线人数--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetRealTimeOnlineNumberAPI - 获取直播间在线人数

最近更新时间：2025.03.24 16:50:54首次发布时间：2022.03.29 22:10:12

获取直播间在线人数，包含虚拟人气。数据每分钟更新一次。

注意事项

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

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetRealTimeOnlineNumberAPI&Version=2020-06-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetRealTimeOnlineNumberAPI`	接口名称。当前 API 的名称为 `GetRealTimeOnlineNumberAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`177916828715`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

返回参数

参数	类型	示例值	描述
RealPopularity	Integer	`1`	直播间真实人数。
FakePopularity	Integer	`1`	直播间虚拟人气。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetRealTimeOnlineNumberAPI&Version=2020-06-01&ActivityId=177916828715

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202201201826170101501312091D1C09D2",
        "Action": "GetRealTimeOnlineNumberAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    },
    "Result": {
        "RealPopularity": 1,
        "FakePopularity": 1
    }
}

错误码

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