获取直播间的渠道列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间的渠道列表

最近更新时间：2023.11.08 09:30:20首次发布时间：2023.02.01 10:27:14

获取直播间的渠道信息列表。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListChannelAPI`	接口名称。当前 API 的名称为 `ListChannelAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`175980616`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
PageItemCount	Integer	否	`10`	分页查询数量。默认取值为 `10`。
PageNo	Integer	否	`1`	分页查询页码。默认取值为 `1`。
Content	String	否	`12`	筛选关键字。支持根据渠道名称或渠道标识进行筛选。

返回参数

参数	类型	示例值	描述
TotalItemCount	Integer	`1`	符合查询条件的渠道总数
PageItemCount	Integer	`10`	分页查询数量
PageNo	Integer	`1`	分页查询页码
Channels	Array of Channels	`-`	渠道信息列表

Channels

参数	类型	示例值	描述
ChannelName	String	`主渠道`	渠道名称
ChannelTag	String	`0`	渠道标识
CreateTime	Long	`1661264062`	渠道的创建时间。Unix 时间戳，单位为秒
PV	Long	`3`	累计观看人次

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListChannelAPI&Version=2020-06-01&ActivityId=175980616&Content=12&PageItemCount=10&PageNo=1

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D5",
    "Action": "ListChannelAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "TotalItemCount": 1,
    "PageNo": 1,
    "PageItemCount": 10,
    "Channels": {
      "ChannelName": "主渠道",
      "ChannelTag": 12,
      "CreateTime": 1661264062,
      "PV": 3
    }
  }
}

错误码

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