获取直播间的主播/品牌方信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间的主播/品牌方信息

最近更新时间：2023.11.08 09:30:20首次发布时间：2022.08.12 10:54:12

获取直播间主播/品牌方的信息列表。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetBusinessAccountInfoAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetBusinessAccountInfoAPI`	接口名称。当前 API 的名称为 `GetBusinessAccountInfoAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`175980616`	直播间 ID。您可通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
IsBusinessAccountEnable	Integer	`1`	是否开启账号设置开关。 `0`：关闭 `1`：开启。页面将展示主播/品牌方账号相关信息。
BusinessAccountInfo	Object of BusinessAccountInfo	`-`	主播/品牌方账号信息列表。

IsBusinessAccountEnable

Integer

1

是否开启账号设置开关。

0：关闭
1：开启。页面将展示主播/品牌方账号相关信息。

BusinessAccountInfo Object of BusinessAccountInfo - 主播/品牌方账号信息列表。

BusinessAccountInfo

参数	类型	示例值	描述
AccountName	String	`fdfd`	主播/品牌方账号名称。
AccountHeadImage	String	`https://xxxxx`	主播/品牌方账号的头像地址。
AccountHeadRedirectUrl	String	`https://xxxxx`	主播/品牌方账号的跳转链接。
HostAccountId	Integer	`32134`	主播/品牌方账号 ID。
IsFollowEnable	Integer	`0`	是否支持粉丝关注。 `0`：不支持 `1`：支持

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetBusinessAccountInfoAPI&Version=2020-06-01&ActivityId=175980616

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D5",
    "Action": "GetBusinessAccountInfoAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "IsBusinessAccountEnable": 1,
    "BusinessAccountInfo": {
      "AccountName": "fdfd",
      "AccountHeadImage": "https://xxxxx",
      "AccountHeadRedirectUrl": "https://xxxxx",
      "HostAccountId": 32134,
      "IsFollowEnable": 0
    }
  }
}

错误码

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