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

您可通过此接口获取指定直播间关联主播账号的名称、头像地址等信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

ActivityId

Long

175980616

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

说明

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

返回参数

参数类型示例值描述

IsBusinessAccountEnable

Integer

1

是否开启账号设置功能。支持以下取值:

  • 0:关闭
  • 1:开启,观看页将展示主播/品牌方账号相关信息。
BusinessAccountInfoObject of BusinessAccountInfo-主播账号信息列表。

BusinessAccountInfo

参数类型示例值描述
AccountNameString账号名称主播账号名称。
AccountHeadImageStringhttps://p.example.org/6ed59yyum2-z75.png主播账号的头像地址。
AccountHeadRedirectUrlStringhttps://example.com主播账号的主页链接。
HostAccountIdLong32134主播账号 ID。

IsFollowEnable

Integer

0

是否开启观众关注主播功能。支持以下取值:

  • 0:关闭
  • 1:开启

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetBusinessAccountInfo&Version=2023-08-01&ActivityId=175980616

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetBusinessAccountInfo",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "IsBusinessAccountEnable": 1,
        "BusinessAccountInfo": {
            "AccountName": "账号名称",
            "AccountHeadImage": "https://p.example.org/6ed59yyum2-z75.png",
            "AccountHeadRedirectUrl": "https://example.com",
            "HostAccountId": 32134,
            "IsFollowEnable": 0
        }
    }
}

错误码

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