智目科技云平台API
  1. 实时监测数据websocket
智目科技云平台API
  • API使用指南
  • 用户
    • 创建用户
      POST
    • 修改用户资料
      POST
    • 修改用户状态
      POST
    • 用户登录
      POST
    • 刷新Token
      GET
    • 获取用户列表
      GET
    • 获取用户详情
      GET
    • 检查用户名是否重复
      GET
    • 获取验证码
      GET
  • 项目
    • 创建项目
      POST
    • 修改项目资料
      POST
    • 修改项目状态
      POST
    • 获取项目列表
      GET
    • 获取项目详情
      GET
    • 获取项目概览信息
      GET
    • 获取项目未处理告警概况
      GET
    • 获取项目中关于监测目标的分析项
      GET
  • 监测目标
    • 创建监测目标
      POST
    • 修改监测目标资料
      POST
    • 修改监测目标状态
      POST
    • 修改监测目标在项目的位置
      POST
    • 获取监测目标列表
      GET
    • 获取监测目标详情
      GET
    • 获取监测目标的趋势分析
      GET
    • 获取最新的监测目标分析
      GET
    • 获取监测目标分析的历史曲线数据
      GET
    • 获取监测目标分析的导出粒度
      GET
    • 导出监测目标的历史分析数据
      POST
    • 获取一段时间监测目标分析项的最大最小值
      GET
  • 设备
    • 创建设备
    • 修改设备资料
    • 修改设备状态
    • 修改设备在监测目标中的位置
    • 获取设备列表
    • 获取设备详情
    • 获取设备可用视频流列表
    • 获取设备下监测点的实时位移
    • 获取监测点的分级统计位移数据
    • 查询设备下监测点的最新瞬时位移
  • 监测点
    • 获取监测点列表
    • 获取设监测点实时数据
    • 获取单个监测点详情
  • 报警
    • 获取报警列表
    • 获取报警详情
    • 关联文件与报警
    • 取消文件与报警关联
    • 创建告警规则
    • 修改告警规则
    • 修改告警规则状态
    • 查询告警规则列表
    • 查询告警规则详情
    • 告警处理
    • 获取告警处理日志
    • 获取监测目标分析的阈值
    • 批量处理告警
  • 文件
    • 获取文件
    • 获取文件列表
    • 文件上传
    • 获取单个文件信息
  • 设备控制API
    • 获取设备视频文件列表
    • 上传日志
    • 上传视频文件
    • 设备拍照
    • 设备重启控制接口
    • 视频控制接口
    • 设备固件下载
    • 固件升级
    • 获取设备日志列表
    • 获取设备运行时状态
    • 获取设备配置信息
  • 报表
    • 获取所有监测对象最近的分析数据对比
    • 获取监测对象的告警对比情况
    • 获取告警类别的对比情况
    • 获取单个监测对象告警环比分析情况
    • 获取项目的告警统计曲线
    • 获取监测目标的告警统计曲线图
    • 获取设备的告警统计曲线图
    • 获取报表分析结论
    • 获取项目下监测对象的分析曲线
    • 返回监测对象下所有分析类型的趋势图
    • 获取监测目标分析值的环比数据
  • 实时监测数据websocket
    • JS使用websocket 接口文档
  • 数据模型
    • RDeviceCameraInfoVo
    • DeviceConfigVO
    • ObjectChainRatio
    • MeasureConfigVO
    • TargetConfigVO
    • Tenant
    • User
    • Project
    • Object
    • Device
    • Measure
    • Alarm
    • File
    • Firmware
    • Operation
    • DeviceConfig
    • Response
    • MeasurePredict
    • AlarmRule
    • ObjectAnalysis
    • PredictPoint
    • SystemConfig
    • ObjectAnalysisItem
    • ProjectSummary
    • AlarmSummary
    • ObjectAlarmMetrics
    • AlarmChainRatio
    • MeasureRecordResult
    • AlarmHandleLogItem
    • AlarmItem
    • DeviceBaseInfoVO
    • ObjectAnalysisItemVO
  1. 实时监测数据websocket

JS使用websocket 接口文档

使用方法#

1. 连接WebSocket#

2. 订阅主题#

3. 取消订阅#

4. 心跳检测(如果需要)#

支持的主题#

通用主题#

device.heartbeat.${DEVICE_SERIAL} - 设备心跳数据
alarm.${PROJECT_ID} - 项目下所有告警数据
model.recovery.${PROJECT_ID} - 模型恢复数据,给前端使用
device.status.${PROJECT_ID} - 设备状态

消息格式#

消息的结构
字段类型含义
typeString消息类型:具体查看后面的消息类型值
messageString消息含义说明
topicString消息对应的topic
timestamplong时间戳
dataobject具体的消息内容
消息类型有:
     // 连接相关
    CONNECTION_ESTABLISHED("连接建立"),
    CONNECTION_CLOSED("连接关闭"),
    
    // 订阅相关
    SUBSCRIBE("订阅"),
    UNSUBSCRIBE("取消订阅"),
    SUBSCRIBE_SUCCESS("订阅成功"),
    UNSUBSCRIBE_SUCCESS("取消订阅成功"),
    
    // 心跳相关
    PING("心跳请求"),
    PONG("心跳响应"),
    
    // 数据推送
    DEVICE_HEARTBEAT("设备心跳数据"),
    DEVICE_STATUS("设备状态"),
    ALARM_DATA("告警数据"),
    MODEL_RECOVERY("模型状态恢复");

设备心跳数据示例#

{
    "type": "DEVICE_HEARTBEAT",
    "message": "设备心跳数据",
    "topic": "device.heartbeat.IVG1MVMDAXXX00000005",
    "timestamp": 1757233743068,
    "data": {
      "deviceSerial": "IVG1MVMDAXXX00000005",
      "measureLiveRecords": [
        {
          "measureId": 626,
          "measureName":"C1-L2-02"
          "x": 0,
          "y": 0
        },
        {
          "measureId": 628,
          "measureName":"C1-L2-03"
          "x": 0,
          "y": 0
        }
      ],
      "timestamp": 1757233743067
    }
}

设备状态数据示例#

{
    "type": "DEVICE_STATUS",
    "message": "设备状态数据",
    "topic": "device.status.1930911930152390658",
    "timestamp": 1757233743068,
    "data": {
      "deviceSerial": "IVG1MVMDAXXX00000005",
      "deviceId": "1213123123124211",
      "onlineStatus":"ONLINE" //设备在线或离线状态ONLINE|OFFLINE
    }
}

实时告警数据示例#

{
    "type": "ALARM_DATA",
    "message": "告警数据",
    "topic": "alarm.1930911930152390658",
    "timestamp": 1757233743068,
    "data": {
        "projectId":"1930911930152390658",
        "alarmId":"1958466752548806657",
        "alarmLevel":"ERROR",
        "alarmCategory":"TARGET_RECOGNITION",
        "alarmType":"EXTERNAL_INTRUSION",
        "alarmContent":"人员闯入已结束,总持续时间:1秒",
        "objectId":null,
        "deviceId":"193091193015239012",
        "measureId":null,
        "extension":null //当特别告警比如倾斜沉降,需要显示2个监测点ID的时候,将最大位移ID(maxMeasureId)和最小位移ID(minMeasureId)放这里。
    }
}

模型恢复数据示例#

对于
{
    "type": "MODEL_RECOVERY",
    "message": "模型状态恢复",
    "topic": "model.recovery.1930911930152390658",
    "timestamp": 1757233743068,
    "data": {
        "projectId":"1930911930152390658",
        "objectId":null,
        "deviceId":"193091193015239012",
        "measureIds":null,  //用List<Integer>类型返回一个或多个measureId。在阈值超限情况下,可能同时存在objectId和measureIds的状态恢复。
        "alarmStatus":"NORMAL" //返回模型的当前状态 NORMAL|WARNING|ERROR。 
    }
}

🎯 前端使用示例#

1. 连接WebSocket#

修改于 2025-10-31 03:30:24
上一页
获取监测目标分析值的环比数据
下一页
RDeviceCameraInfoVo
Built with