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

获取直播间的渠道列表

最近更新时间：2023.02.01 10:27:14

首次发布时间：2023.02.01 10:27:14

我的收藏

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

请求说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt64是直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
PageItemCountInt32否分页查询数量。默认取值为 10
PageNoInt32否分页查询页码。默认取值为 1
ContentString否筛选关键字。支持根据渠道名称或渠道标识进行筛选

返回参数

参数类型描述
TotalItemCountInt32符合查询条件的渠道总数
PageItemCountInt32分页查询数量
PageNoInt32分页查询页码
ChannelsArray of Channel渠道信息列表

Channel

参数类型描述
ChannelNameString渠道名称
ChannelTagString渠道标识
CreateTimeInt64渠道的创建时间。Unix 时间戳，单位为秒
PVInt64累计观看人次

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=ListChannelAPI&Version=2020-06-01&ActivityId=1231231231

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221229230456A75113C5Dxxxxxx",
        "Action": "ListChannelAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1672326296
    },
    "Result": {
        "TotalItemCount": 1,
        "PageNo": 1,
        "PageItemCount": 10,
        "Channels": [
            {
                "ChannelName": "主渠道",
                "ChannelTag": "0",
                "CreateTime": 1661264062,
                "PV": 3,
            },
        ]
    }
}

异常返回示例

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

错误码

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