You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取主播账号列表

最近更新时间：2022.09.29 17:29:32

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

我的收藏

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

请求说明

  • 接口名称：ListHostAccountAPI
  • 请求方式：GET
  • 接口地址：http://livesaas.volcengineapi.com/?Action=ListHostAccountAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

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

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01
PageNoInt否分页查询页码，默认值为 1
PageItemCountInt否分页查询数量，默认值为 10
HostAccountIdInt否主播账号 ID
HostAccountNameString否主播账号名称

返回参数

参数类型描述
PageNoInt分页查询页码
PageItemCountInt分页查询数量
TotalItemCountInt查询到的主播总数
HostAccountArray of HostAccountInfo主播账号信息列表

HostAccountInfo

参数类型描述
IdInt主播账号 ID
NameString主播账号名称
AvatarUrlString主播账号头像地址
HomeUrlString主播账号关联的主页链接
CreateTimeInt主播账号的创建时间，Unix 时间戳，单位为秒

IsFollowEnable

Int

是否支持粉丝关注。

  • 0：不支持；
  • 1：支持。

示例

请求示例

Get http://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":"",
                "IsFollowEnable": 0
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"ListHostAccountAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
    }
}

错误码

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