1. 视频监控列表

外部获取视频监控列表

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 基本信息

概况 内容
接口地址 /api/platform/v2/device/monitor/external/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之间的整数

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 响应码
message string 响应消息
data object 响应数据
total number 总数
list array 数据列表
projectId string 项目id
monitorId string 设备id
type number 设备类型 1-萤石云 2-乐橙云 3-普通类型 4-国标 5-云眸
serialNumber string 设备序列号(萤石云、云眸、国标)
channelNo string 通道号
name string 摄像头名称
coverUrl string 封面地址
sourceUrl string 播放地址
state number 设备状态 0离线,1在线
sort number 排序
pages number 页数
hasNext boolean 是否有下一页

响应数据结构如下所示:

{
    "code": 0,
    "message": null,
    "data": {
        "total": 1,
        "list": [
            {
                "projectId": "1dc5f3cd789d44d88f98eb3fe22159fd",
                "monitorId": "3a59202cdd944afabb2ee99f14fe911a",
                "type": 1,
                "serialNumber": "AC27484360",
                "channelNo": "5",
                "name": "测试-萤石摄像头(勿删)",
                "coverUrl": "https://qingzhu-test.obs.cn-east-3.myhuaweicloud.com",
                "sourceUrl": "http://hls01open.ys7.com/openlive/89.m3u8",
                "state": 1,
                "sort": 1
            }
        ],
        "pages": 1,
        "hasNext": false
    }
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""