You need to enable JavaScript to run this app.
导航

获取主播账号列表

最近更新时间2023.11.08 09:30:20

首次发布时间2022.08.12 10:53:54

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListHostAccountAPI接口名称。当前 API 的名称为 ListHostAccountAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
PageNoInteger1分页查询页码,默认值为 1
PageItemCountInteger10分页查询数量,默认值为 10
HostAccountIdInteger2333主播账号 ID。
HostAccountNameString字节直播主播主播账号名称。

返回参数

参数类型示例值描述
PageNoInteger1分页查询页码。
PageItemCountInteger10分页查询数量。
TotalItemCountInteger1查询到的主播总数。
HostAccountArray of HostAccount-主播账号信息列表。

HostAccount

参数类型示例值描述
IdInteger2333主播账号 ID。
NameString字节直播主播主播账号名称。
AvatarUrlStringhttps://xxxxx主播账号头像地址。
HomeUrlStringhttps://xxxxx主播账号关联的主页链接。
CreateTimeInteger1657525387主播账号的创建时间,Unix 时间戳,单位为秒。

IsFollowEnable

Integer

0

是否支持粉丝关注。

  • 0:不支持
  • 1:支持

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D5",
    "Action": "ListHostAccountAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "PageItemCount": 10,
    "PageNo": 1,
    "TotalItemCount": 1,
    "HostAccount": [
      {
        "Id": 2333,
        "Name": "字节直播主播",
        "CreateTime": 1657525387,
        "AvatarUrl": "https://xxxxx",
        "HomeUrl": "https://xxxxx",
        "IsFollowEnable": 0
      }
    ]
  }
}

错误码

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