You need to enable JavaScript to run this app.
导航
UpdateActivityHostAccount - 更新直播间关联主播账号设置
最近更新时间:2025.03.24 16:50:57首次发布时间:2024.06.19 11:38:23
我的收藏
有用
有用
无用
无用

调用 UpdateActivityHostAccount 接口,更新指定直播间的关联主播账号,以及账号设置功能的开启状态。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的营销互动 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

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

请求参数

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

Query

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

Body

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

ActivityId

Long

175980616

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

HostAccountId

Long

13144

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

说明

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

IsBusinessAccountEnable

Integer

1

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

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

返回参数

参数类型示例值描述

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": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

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