您可通过此接口获取当前账号下主播账号的名称、头像地址等信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListHostAccounts | 接口名称。当前 API 的名称为 ListHostAccounts。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| PageNo | Integer | 否 | 1 | 分页查询页码。默认值为 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量。取值范围为 [1,200]，默认值为 10。 |
| HostAccountId | Integer | 否 | 2333 | 主播账号 ID。 |
| HostAccountName | String | 否 | 字节直播主播 | 主播账号名称。支持模糊查询。最多支持输入 20 个字符。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNo | Integer | 1 | 分页查询页码。 |
| PageItemCount | Integer | 10 | 分页查询数量。 |
| TotalItemCount | Integer | 1 | 查询到的主播总数。 |
| HostAccounts | Array of HostAccounts | - | 主播账号信息列表。 |
| GetFollowDataUrl | String | https://example.com | 查询接口 URL，用于查询用户是否关注主播。详见关注主播接口。 |
| UpdateFollowDataUrl | String | https://example.com | 更新接口 URL，用于更新用户关注主播状态。详见关注主播接口。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Long | 2333 | 主播账号 ID。 |
| Name | String | 字节直播主播 | 主播账号名称。 |
| AvatarUrl | String | https://p.example.org/6ed59yyum2-z75.png | 主播账号的头像地址。 |
| HomeUrl | String | https://example.com | 主播账号的主页链接。 |
| CreateTime | Integer | 1657525387 | 主播账号的创建时间，Unix 时间戳，单位为秒。 |
IsFollowEnable | Integer |
| 是否开启观众关注主播功能。支持以下取值：
|
GET https://livesaas.volcengineapi.com/?Action=ListHostAccounts&Version=2023-08-01&PageNo=1&PageItemCount=10&HostAccountId=2333&HostAccountName=%E5%AD%97%E8%8A%82%E7%9B%B4%E6%92%AD%E4%B8%BB%E6%92%AD
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListHostAccounts", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1656067132 }, "Result": { "PageNo": 1, "PageItemCount": 10, "TotalItemCount": 1, "GetFollowDataUrl": "https://example.com", "UpdateFollowDataUrl": "https://example.com", "HostAccounts": [ { "Id": 2333, "Name": "字节直播主播", "AvatarUrl": "https://p.example.org/6ed59yyum2-z75.png", "HomeUrl": "https://example.com", "CreateTime": 1657525387, "IsFollowEnable": 0 } ] } }