开发者平台 / 视频管理系统(VMS)/ API功能接口定义 / 直播管理
4.8.7 获取直播列表
接口说明:
名称 | 内容 | |
---|---|---|
URL | https://xxx/tums/live/v1/getLiveList | |
功能说明 | 获取直播列表 | |
使用限制 | 无 |
请求参数:
参数名称 | 参数描述 | |
---|---|---|
params grid |
start Iong | 搜索开始的位置 |
limit Integer | 范围1~100 | |
filterAnd Map |
与条件 “regionId”,区域ID,必填 "liveStatusEqual":0,仅显示已开通 | |
filterOr Map |
或条件 相关关键词模糊搜索 | |
sort List |
排序方式 可通过“devName” 、“deviceStatus”、“liveStatus”进行排序 |
返回参数:
参数名称 | 参数描述 | ||
---|---|---|---|
result | total int | 满足条件的设备总个数 | |
List List<liveInfo> |
devId String | 设备ID | |
devName String | 设备名称 | ||
deviceStatus int | 0为离线,1为在线 | ||
liveStatus int | 0:开通 1:关闭,2:暂停 | ||
visitTimes int | 观看人数 | ||
lastDayVisit int | 近1天访问 | ||
lastWeekVisit int | 近7天访问 | ||
lastMonthVisit int | 近30天访问 | ||
error_code | 返回码,0 – 成功,其他- 失败,具体请参考返回码章节 |
代码示例
https://xxx/tums/live/v1/getLiveList request: { "start":0, "limit":20, "filterAnd":{"regionId":1}, "filterOr":{}, "sort":[] } response: { "result": { "total": 2, "list": [ { "devId": "2", "devName": "virtual_device_3", "deviceStatus": 0, "liveStatus": 0, "visitTimes": 10, "liveStatus": 0, "lastDayVisit": 10, "lastWeekVisit": 0, "lastMonthVisit": 0 }] }, "error_code": 0 }