获取直播分组的观众信息列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播分组的观众信息列表

最近更新时间：2024.11.01 11:15:22首次发布时间：2024.06.19 11:42:26

您可通过此接口获取指定直播间中指定直播分组的观众信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
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	否	`A`	根据观众的唯一标识或用户 ID 进行查询。唯一标识支持模糊查询。观众通过不同方式登录直播间，其唯一标识的取值如下所示。公开：观众昵称。密码：观众昵称。邀请码：观众昵称。白名单：观众登录时输入的白名单信息。飞书：飞书昵称。微信：观众昵称。企业微信：观众昵称。手机号：观众登录时输入的手机号。自定义：自定义登录时通过 `UserId` 传入的值。详见自定义登录。 OAuth 2.0：您自有账号系统中用户 ID 对应的字段。说明如果您集成了 Web 观播 SDK，且 SDK 的鉴权模式为自定义模式（即 `mode` = `2`），唯一标识的取值为调用 GetSDKTokenAPI 接口时传入的 `UserIdStr`（观众 ID）。

返回参数

参数	类型	示例值	描述
AudienceGroupUsers	Array of AudienceGroupUsers	`-`	观众信息列表。
TotalCount	Long	`1`	观众总数。

AudienceGroupUsers

参数	类型	示例值	描述
FlagId	String	`昵称A`	观众的唯一标识。观众通过不同方式登录直播间，其唯一标识的取值如下所示。公开：观众昵称。密码：观众昵称。邀请码：观众昵称。白名单：观众登录时输入的白名单信息。飞书：飞书昵称。微信：观众昵称。企业微信：观众昵称。手机号：观众登录时输入的手机号。自定义：自定义登录时通过 `UserId` 传入的值。详见自定义登录。 OAuth 2.0：您自有账号系统中用户 ID 对应的字段。说明如果您集成了 Web 观播 SDK，且 SDK 的鉴权模式为自定义模式（即 `mode` = `2`），唯一标识的取值为调用 GetSDKTokenAPI 接口时传入的 `UserIdStr`（观众 ID）。
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=A

返回示例

{
    "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
            }
        ]
    }
}

错误码

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