Polyv Help Center

Help Center

Get Live Monitoring List for App Channels

Updated: 2022-05-23 17:56:23

Interface URL

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

Interface Description

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

Supported Format

JSON

Request Method

GET

Request Limit

TRUE

Request Parameters

Parameter Required Type Description
appId Yes string Admin's appId
timestamp Yes long 13-digit current timestamp
sign Yes string Signature value
userId No string App ID, leave empty to query all apps
page No int Page number, defaults to page 1
pageSize No int Number of items per page, defaults to 1
status No string Live status ("live": live, "end": no live, "waiting": waiting, "pull": pulling stream, "disk": hard disk live)
scene No string Live scene ("alone": event live, "ppt": three-screen, "topclass": large class)
channelId No int Channel ID
channelName No int Channel name, supports fuzzy search

Successful Response JSON Example:

{
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": ""
}

Field Description

Parameter Description
code Response status code, e.g., 200
status Response status
message Error message
data Response result set
pageNumber Current page number
totalItems Total number of items
contents Query result list
publishId Push stream log ID
channelId Channel ID
userId App ID
ipAddress Push stream IP
stream Stream name
status Live status ("live": live, "end": no live, "waiting": waiting, "pull": pulling stream, "disk": hard disk live)
startTime Live start time
endTime Live end time
createdTime Creation time
lastModified Update time
channelName Channel name
scene Live scene ("alone": event live, "ppt": three-screen, "topclass": large class)
captureImg Live screenshot URL
appId App ID corresponding to the channel
firstPage Whether it is the first page, value: true/false
lastPage Whether it is the last page, value: true/false
nextPageNumber Next page number
prePageNumber Previous page number
totalPages Total number of pages
startRow Position of the first record on the current page in the total records
endRow Position of the last record on the current page in the total records
limit Number of records on the current page
联系客服,在线咨询