1. 获取视频监控列表(项目)
获取指定项目下视频监控列表,含视频监控直播流地址
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/platform/v2/device/monitor/simple/list |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
1.2.2. 请求参数(request-parameter)
字段 | 是否必传 | 描述 |
---|---|---|
projectId | 是 | 项目ID |
pageNum | 是 | 页码,整数,从1开始 |
pageSize | 是 | 分页数据量,取值为1到100之间的整数 |
refresh | 否 | 针对海康萤石设备的直播流地址的强制刷新参数,0-不刷新,1-强制刷新,默认0 |
参数请求示例:
http://api.example.com/xxx?key=value
1.3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 响应码 |
message | string | 是 | 响应消息 |
data | object | 是 | 响应数据 |
tatal | number | 是 | 总数 |
pages | number | 是 | 页数 |
hasNext | boolean | 是 | 是否有下一页 |
list | array | 是 | 分页数据 |
monitorId | string | 是 | 摄像头id |
name | string | 是 | 摄像头名称 |
type | number | 是 | 摄像头类型:1-萤石云 2-乐橙云 3-普通类型 4-国标 5-云眸 |
state | number | 是 | 设备状态 :0=离线 1=在线 2=异常 |
coverUrl | string | 是 | 封面地址url |
sourceUrl | string | 是 | 播放地址 |
响应数据结构如下所示:
{
"code": 1,
"message": "XXX",
"data": {
"tatal": 1,
"pages": 1,
"hasNext": false,
"list": [{
"monitorId": "",
"name": "",
"type": 1,
"state": 1,
"coverUrl": "",
"sourceUrl": ""
}]
}
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。