保利威文档中心

幫助中心

取得應用頻道的直播監控列表

更新時間: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 當前頁的記錄個數
联系客服,在线咨询