更新直播分组配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新直播分组配置信息

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

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

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateAudienceGroupConfig`	接口名称。当前 API 的名称为 `UpdateAudienceGroupConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1798512283226155`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
GroupType	Integer	否	`0`	分组方式。支持以下取值： `0`：人工分组 `1`：随机分组
GroupEnableStatus	Integer	否	`0`	是否开启直播分组功能。支持以下取值： `0`：关闭 `1`：开启
ViewPageShowGroupName	Integer	否	`0`	是否开启在观看页展示观众分组信息功能。支持以下取值： `0`：关闭 `1`：开启
CannotWatchLiveWhenNotInGroup	Integer	否	`0`	是否开启不在分组内的观众无法观看直播功能。支持以下取值： `0`：关闭 `1`：开启

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否更新成功。支持以下取值： `true`：成功 `false`：失败

Status

Boolean

true

是否更新成功。支持以下取值：

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateAudienceGroupConfig&Version=2023-08-01
{
    "ActivityId": 1798512283226155,
    "GroupType": 0,
    "GroupEnableStatus": 0,
    "ViewPageShowGroupName": 0,
    "CannotWatchLiveWhenNotInGroup": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateAudienceGroupConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1705992306
    },
    "Result": {
        "Status": true
    }
}

错误码

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