您可通过此接口获取指定直播间的实时观众列表,包括在线观众人数、总计观众人数等基础信息,以及观众是否被禁言、踢出、封禁 IP 等详细信息。
说明
如返回主持人信息,则主持人信息会在第一页的第一条展示。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListActivityUsers | 接口名称。当前 API 的名称为 ListActivityUsers 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
ActivityId | Long | 是 | 1770637081234 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
PageNumber | Integer | 否 | 1 | 分页查询页码。默认值为 1 。 |
PageSize | Integer | 否 | 50 | 分页查询数量。默认值为 50 。取值范围为 [1, 100]。 |
SearchName | String | 否 |
| 观众昵称。支持模糊搜索。 说明 传入该参数后,不会返回主持人信息。 |
SearchStatus | Integer | 是 |
| 观众状态。取值如下:
|
SearchAudienceGroupId | Long | 否 |
| 观众的直播分组 ID。默认值为
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 | 分页查询页码。 |
PageSize | Integer | 50 | 分页查询数量。 |
TotalCount | Integer | 1 | 查询结果总数。 |
OnlineUserCount | Integer | 15 | 在线观众人数。 |
TotalUserCount | Integer | 22 | 总计观众人数。 |
UserMsgs | Array of UserMsgs | - | 用户信息列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserId | Long |
| 用户 ID。 说明 主持人的用户 ID 为 |
UserName | String | 观众 A | 用户昵称。 |
SilenceStatus | Integer |
| 用户是否被禁言。
|
OnlineStatus | Integer |
| 用户在线状态。
|
IsPresenter | Integer |
| 用户是否是主持人。
说明 当取值为 |
UserCookie | Long |
| 用户的设备 ID。 说明 主持人的设备 ID为 |
ExternalUserId | String | id123412 | 用户在第三方平台的唯一标识。 |
IsBannedUser | Integer |
| 用户是否被踢出直播间。
|
IsBannedIP | Integer |
| 用户的 IP 地址是否被封禁。
|
IP | String | 192.168.1.1 | 用户的 IP 地址。 |
ShiftScreenNumber | Integer | 1 | 用户触发切屏检测提醒弹窗的次数。 |
MuteNumber | Integer | 2 | 用户触发静音停播提醒弹窗的次数。 |
NoInteractNumber | Integer | 3 | 用户触发无互动检测提醒弹窗的次数。 |
UserCredit | Integer | 11 | 用户获得的表扬次数。 |
AudienceGroupId | Long | 1804192687521234 | 用户的直播分组 ID。 |
GET https://livesaas.volcengineapi.com/?Action=ListActivityUsers&Version=2023-08-01&ActivityId=1770637081234&SearchStatus=2
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListActivityUsers", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1721111109 }, "Result": { "PageNumber": "1", "PageSize": "50", "TotalCount": "1", "OnlineUserCount": "15", "TotalUserCount": "22", "UserMsgs": [ { "UserId": 1805597150511234, "UserName": "观众 A", "SilenceStatus": 1, "OnlineStatus": 0, "IsPresenter": 0, "UserCookie": 1721923438191234, "ExternalUserId": "id123412", "IsBannedUser": 0, "IsBannedIP": 0, "ShiftScreenNumber": 1, "MuteNumber": 2, "NoInteractNumber": 3, "UserCredit": 11, "AudienceGroupId": 1804192687521234, "IP": "192.168.1.1" } ] } }