获取主播账号列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取主播账号列表

最近更新时间：2025.05.14 17:44:15首次发布时间：2022.08.12 10:53:54

获取当前账号下已添加主播的信息列表。

说明

该接口已经不再维护，建议调用 ListHostAccounts 接口获取主播账号列表。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListHostAccountAPI`	接口名称。当前 API 的名称为 `ListHostAccountAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
PageNo	Integer	否	`1`	分页查询页码，默认值为 `1`。
PageItemCount	Integer	否	`10`	分页查询数量，默认值为 `10`。
HostAccountId	Integer	否	`2333`	主播账号 ID。
HostAccountName	String	否	`A`	主播账号名称。

返回参数

参数	类型	示例值	描述
PageNo	Integer	`1`	分页查询页码。
PageItemCount	Integer	`10`	分页查询数量。
TotalItemCount	Integer	`1`	查询到的主播总数。
HostAccount	Array of HostAccount	`-`	主播账号信息列表。

HostAccount

参数	类型	示例值	描述
Id	Integer	`2333`	主播账号 ID。
Name	String	`主播 A`	主播账号名称。
AvatarUrl	String	`https://example.com/a.png`	主播账号头像地址。
HomeUrl	String	`https://example.com`	主播账号关联的主页链接。
CreateTime	Integer	`1657525387`	主播账号的创建时间，Unix 时间戳，单位为秒。
IsFollowEnable	Integer	`0`	是否支持粉丝关注。 `0`：不支持 `1`：支持

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListHostAccountAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "PageNo": 1,
        "PageItemCount": 10,
        "TotalItemCount": 1,
        "HostAccount": [
            {
                "Id": 2333,
                "Name": "主播 A",
                "AvatarUrl": "https://example.com/a.png",
                "HomeUrl": "https://example.com",
                "CreateTime": 1657525387,
                "IsFollowEnable": 0
            }
        ]
    }
}

错误码

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