保利威文档中心

帮助中心

获取应用频道的直播监控列表

更新时间:2022-05-23 17:56:23

接口URL

https://api.polyv.net/live/v2/app/monitor/list

接口说明

1、接口用于应用频道的直播监控
2、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 管理员的appId
timestamp long 13位当前时间戳
sign string 签名值
userId string 应用ID,不传查询全部应用
page int 第几页,默认为第一页
pageSize int 一页显示多少条,默认为1条
status string 直播状态 ("live": 直播中, "end": 暂无直播, "waiting": 等待直播, "pull": 拉流直播中,"disk":硬盘直播中)
scene string 直播场景 ("alone": 活动直播,"ppt": 三分屏, “topclass”:大班课
channelId int 频道ID
channelName int 频道名称,支持模糊搜索

响应成功JSON示例:

{
code: 200,
status: "success",
message: "",
data: {
pageSize: 5,
pageNumber: 1,
totalItems: 67,
contents: [
{
    publishId: "3131313",
    userId: "232323",
    channelId: 10001,
    ipAddress: "127.0.0.1",
    stream: "dadajhdadahdjkahdk",
    status: "live",
    startTime: "2018-01-01 00:00:00",
    endTime: "2018-01-01 02:00:00",
    currentDay: "2018-01-01",
    createdTime: "2018-01-01 02:00:00",
    lastModified: "2018-01-01 02:00:00",
    isNgbEnabled: "N",
    isUrlProtected: "Y",
    channelName: "频道",
    scene: "alone",
    captureImg: "http://www.polyv.net/1.png",
    appId:"xxxxxxxx"
}
],
startRow: 1,
firstPage: true,
lastPage: false,
nextPageNumber: 2,
prePageNumber: 1,
limit: 5,
endRow: 5,
totalPages: 14,
offset: 0
}
}
###     响应失败JSON示例:

未输入appId
```json
{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

字段说明

参数名 说明
code 响应的状态码,例如:200
status 响应状态
message 异常错误信息
data 响应结果集
pageNumber 当前的页数
totalItems 总的条数
contents 查询的结果列表
publishId 推流日志ID
channelId 频道ID
userId 应用ID
ipAddress 推流IP
stream 流名
status 直播状态 ("live": 直播中, "end": 暂无直播, "waiting": 等待直播, "pull": 拉流直播中,"disk":硬盘直播中)
startTime 直播开始时间
endTime 直播结束时间
createdTime 创建时间
lastModified 更新时间
channelName 频道名称
scene 直播场景 ("alone": 活动直播,"ppt": 三分屏, “topclass”:大班课)
captureImg 直播截图地址
appId 频道对应的应用ID
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一条记录在总的记录数中的位置
endRow 当前页最后一条记录在总的记录数中的位置
limit 当前页的记录个数
联系客服,在线咨询