您可通过此接口获取指定直播间中指定直播分组的观众信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListAudienceGroupUser | 接口名称。当前 API 的名称为 ListAudienceGroupUser。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| ActivityId | Long | 是 | 1798535265384505 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
| AudienceGroupId | Long | 否 | 1798535265384504 | 分组 ID。您可以通过 GetAudienceGroupConfig 接口查询 ID。不传则默认取值0。 |
| PageNumber | Integer | 是 | 1 | 分页查询页码。取值大于等于 1。 |
| PageSize | Integer | 是 | 100 | 分页查询数量。取值范围为 [1,100]。 |
SearchKeyWord | String | 否 |
| 根据观众的唯一标识或用户 ID 进行查询。唯一标识支持模糊查询。
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AudienceGroupUsers | Array of AudienceGroupUsers | - | 观众信息列表。 |
| TotalCount | Long | 1 | 观众总数。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| FlagId | String | 昵称A | 观众的唯一标识。 |
| UserId | Long | 1798535265384507 | 用户 ID。 |
| AudienceGroupName | String | 分组1 | 分组名称。 |
| AudienceGroupId | Long | 17935265384504 | 分组 ID。 |
GET https://livesaas.volcengineapi.com/?Action=ListAudienceGroupUser&Version=2023-08-01&ActivityId=1798535265384505&AudienceGroupId=1798535265384504&PageNumber=1&PageSize=100&SearchKeyWord=%E6%98%B5%E7%A7%B0A
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListAudienceGroupUser", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1705992306 }, "Result": { "TotalCount": 1, "AudienceGroupUsers": [ { "FlagId": "昵称A", "UserId": 1798535265384507, "AudienceGroupName": "分组1", "AudienceGroupId": 17935265384504 } ] } }