获取直播分组配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播分组配置信息

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

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

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAudienceGroupConfig`	接口名称。当前 API 的名称为 `GetAudienceGroupConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1770637083012`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
IsNeedTotalCount	Boolean	否	`true`	是否返回每个分组的观众数量。支持以下取值，不传则默认取值`false`： `true`：返回 `false`：不返回

返回参数

参数	类型	示例值	描述
GroupType	Integer	`0`	直播分组方式。支持以下取值： `0`：人工分组 `1`：随机分组
GroupEnableStatus	Integer	`1`	是否开启直播分组功能。支持以下取值： `0`：关闭 `1`：开启
ViewPageShowGroupName	Integer	`0`	是否开启在观看页展示观众分组信息功能。支持以下取值： `0`：关闭 `1`：开启
CannotWatchLiveWhenNotInGroup	Integer	`0`	是否开启不在分组内的观众无法观看直播功能。支持以下取值： `0`：关闭 `1`：开启
AudienceGroupsBasicInfo	Array of AudienceGroupsBasicInfo	`-`	直播分组信息列表。

AudienceGroupsBasicInfo

参数	类型	示例值	描述
GroupId	Long	`17707083013`	分组 ID。取值为 `0`，表示未分组分组。
GroupName	String	`分组1`	分组名称。
TotalCount	Long	`10`	分组的观众数量。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetAudienceGroupConfig&Version=2023-08-01&ActivityId=1770637083012&IsNeedTotalCount=true

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetAudienceGroupConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1705992306
    },
    "Result": {
        "GroupType": 0,
        "GroupEnableStatus": 1,
        "ViewPageShowGroupName": 0,
        "CannotWatchLiveWhenNotInGroup": 0,
        "AudienceGroupsBasicInfo": [
            {
                "GroupName": "分组1",
                "TotalCount": 10,
                "GroupId": 17707083013
            }
        ]
    }
}

错误码

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