更新直播间关联主播账号设置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新直播间关联主播账号设置

最近更新时间：2024.10.28 12:01:51首次发布时间：2024.06.19 11:38:23

您可通过此接口更新指定直播间的关联主播账号，以及账号设置功能的开启状态。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
HostAccountId	Long	否	`13144`	待与直播间关联的主播账号 ID。您可以通过 ListHostAccounts 接口查询 ID。说明当 `IsBusinessAccountEnable` 取值为 `1` 时，该参数必选。如需开启观众关注主播功能，请将直播间的观看限制设置为自定义。详见自定义账号。
IsBusinessAccountEnable	Integer	否	`1`	是否开启账号设置功能。支持以下取值，默认取值为 `0`。 `0`：关闭 `1`：开启，观看页即可展示主播账号的相关信息。
ActivityId	Long	是	`175980616`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

HostAccountId

Long

否

13144

待与直播间关联的主播账号 ID。您可以通过 ListHostAccounts 接口查询 ID。

说明

当 IsBusinessAccountEnable 取值为 1 时，该参数必选。
如需开启观众关注主播功能，请将直播间的观看限制设置为自定义。详见自定义账号。

IsBusinessAccountEnable

Integer

否

1

是否开启账号设置功能。支持以下取值，默认取值为 0。

0：关闭
1：开启，观看页即可展示主播账号的相关信息。

ActivityId Long 是 175980616 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述

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

Status

Boolean

true

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

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityHostAccount&Version=2023-08-01
{
    "HostAccountId": 13144,
    "IsBusinessAccountEnable": 1,
    "ActivityId": 175980616
}

返回示例

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

错误码

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