查询频道列表

最近更新时间:2019-07-01 11:53:40

1.接口描述

  • 接口
    Live_Channel_GetChannelList:查询频道列表。
  • 地址
    API 调用地址为:http://fcgi.video.qcloud.com/common_access
  • 用途
    在直播码模式下,用于查询当前频道列表。
  • 说明
    可以查询特定状态的频道列表,如可过滤当前处于开启状态的频道。

2.输入参数

参数名 参数含义 类型 备注 是否必需
appid 客户 ID int - Y
interface 接口名 string Live_Channel_GetChannelList Y
t 有效截止时间戳 int - Y
sign 签名 string md5(key+ 有效截止时间戳) Y
Param.n.status 0:断流,1:开启,3:关闭 int - N
Param.n.page_no 分页页码 int 从 1 开始,默认为 1 N
Param.n.page_size 分页大小 int 10~100,默认为 10 N
Param.s.order_field 排序字段 string 可选字段:create_time,默认为create_time N
Param.n.order_by_type 排序方法 int 0:正序,1:倒序 N

3.输出结果

参数名 参数含义 类型 备注
ret 返回码 int 0:成功;其他值:失败
message 错误信息 string 错误描述
output 消息内容 array

其中 output 部分结构为:

字段名 含义 类型 备注
all_count 总个数 int
channel_list 列表 array

其中 channel_list 部分结构为:

参数名 参数含义 类型 备注
channel_id 频道 ID string -
channel_name 频道名 string -
create_mode 创建模式 string -
create_time 创建时间 string -
path 推流路径 Array(String) -
status 状态 Int 0:无输入,1:正常,2:服务错误,3:关闭,4:禁止
watermark_id 水印 ID String -

4.调用示例

目标:查询该帐号下当开启的频道列表

组成部分 示例内容
接口 URL http://fcgi.video.qcloud.com/common_access?
Param.n.status 1
Param.n.page_no 1
Param.n.page_size 20
Param.s.order_field create_time
Param.n.order_by_type 0
// copy时请去掉美化排版用的不可见换行符,否则可能出现 “appid is invalid” 等url拼装错误
 URL = http://fcgi.video.qcloud.com/common_access?
            appid=1234&interface=Live_Channel_GetChannelList
            &t=1471850187&sign=b17971b51ba0fe5916ddcd96692e9fb3
            &Param.n.status=1&Param.n.page_no=1&Param.n.page_size=20
            &Param.s.order_field=create_time&Param.n.order_by_type=0