海康云眸 IoT API
  1. 消息通道
海康云眸 IoT API
  • 产品介绍
  • 能力概览
  • 错误码表
  • 报警类型表
  • 常见问题
  • 示例DEMO
  • 快速入门
    • 接口调用说明
    • 生成授权凭证
      POST
  • 基础服务能力
    • 设备分组管理
      • 新增组
      • 删除组
      • 更新组
      • 获得单个组详情
      • 查询所有节点列表
      • 查找组的下级节点
    • 设备管理
      • 注册设备
      • 注销设备
      • 修改设备名称
      • 获得单个设备信息
      • 获得设备列表
      • 获取设备总数
      • 查询设备状态
    • 设备确权
      • 确权流程说明
      • 下线确认
      • 上线确认
    • 通道管理
      • 查询设备下通道列表
      • 同步设备下通道
      • 修改通道名称
    • 人员管理
      • 添加人员
      • 更新人员信息
      • 删除人员信息
      • 获得单个人员详情
      • 人脸评分标准配置接口
      • 人员人脸更新
      • 人员人脸删除
  • 报警能力管理
    • 获取报警能力列表
      GET
    • 修改报警能力状态
      POST
  • 视频服务能力
    • 视频对接指南
    • 视频参数配置
      • 视频设备码流参数配置指南
      • 接口配置
        • 获取音视频单通道编码能力
        • 获取音视频单通道编码配置
        • 设置音视频单通道编码配置
    • 视频集成方案
      • web视频控件
      • UIKIT
      • 微信小程序
      • 移动端SDK
        • Android
        • IOS
        • 错误码对照表
      • 标准流预览
        • 开通标准流预览功能
        • 获取标准流预览地址
        • 获取预览/回放地址
      • 互动直播间
        • 创建直播间
        • 编辑直播间
        • 删除直播间
        • 查询直播间列表
        • 设置直播间状态
        • 账号充值
    • 设备视频加密
      • 关闭设备视频加密
      • 开启设备视频加密
    • 云台控制
      • 开始云台控制
      • 停止云台控制
      • 3D放大
    • 预置点操作
      • 添加预置点
      • 更新预置点
      • 清除预置点
      • 调用预置点
      • 加载预置点
    • 取流认证
      GET
    • 远程抓图
      POST
  • 门禁服务能力
    • 门禁对接指南
    • 卡片操作
      • 新增卡片
      • 删除卡片
      • 根据人员编号删除卡片
    • 门禁计划
      • 计划模板管理
        • 周计划模板添加/更新
        • 周计划模板获取
        • 周计划模板删除
        • 假日计划模板添加/更新
        • 假日计划模板获取
        • 假日计划模板删除
      • 门禁计划管理
        • 周计划配置
        • 周计划获取
        • 假日计划配置
        • 假日计划获取
        • 假日组计划配置
        • 假日组计划获取
        • 门禁计划配置
        • 门禁计划聚合配置
        • 门禁计划获取
        • 清空门禁计划
    • 权限分组
      • 权限组新增
      • 权限组更新
      • 权限组删除
      • 获取权限组列表
      • 权限组绑定人员
      • 权限组解绑人员
      • 权限组获取人员编号列表
      • 权限组绑定设备
      • 权限组解绑设备
      • 权限组获取设备序列号列表
      • 人员权限信息查询
    • 权限下发
      • 根据权限组下发权限
      • 查询下发失败记录
      • 下发所有失败人员
      • 清空设备本地权限
      • 获取设备能力集
      • 人员权限信息更新
    • 远程控门
      • 远程控门
      • 远程呼梯
    • 可视对讲
      • 设置可视对讲通知地址
      • 可视对讲交互事件通知
      • 获取可视对讲通知地址
    • 人员信息采集
      • 远程采集方式
        • 规则配置
        • 获取规则配置
        • 采集身份证信息
        • 采集卡信息
        • 采集指纹信息
        • 采集人脸信息
        • 获取人脸采集进度
      • 本地采集方式
        • 规则配置
        • 获取规则配置
        • 录入人员信息
        • 查询采集数据
        • 获取采集状态信息
        • 删除全部采集数据
        • 根据人员编号删除采集数据
    • 多重认证
      • 获取群组配置
      • 群组配置
      • 清除群组配置
      • 获取多重认证配置
      • 设置多重认证配置
    • 访客二维码生成
    • 设备本地事件查询
  • 边缘人脸服务能力
    • 边缘人脸对接指南
    • 人脸库管理
      • 创建人脸库
      • 删除全部人脸库
      • 删除单个人脸库
      • 获取所有人脸库基本参数
      • 批量设置人脸库基本参数
      • 获取单个人脸库基本参数
      • 设置单个人脸库基本参数
      • 查询人脸库剩余人脸数及磁盘容量
    • 人脸库人脸管理
      • 查询单个人脸库中人脸信息
      • 删除单个人脸库中人脸
    • 人脸下发入库
      • 人脸批量异步下发
      • 查询人脸异步下发任务状态
      • 查询人脸异步下发所有任务状态
      • 人脸下发底图入库状态查询
      • 人脸异步下发任务删除
    • 设置人脸比对参数配置
      • 设置人脸比对参数配置
      • 获取人脸比对参数配置
      • 设置人脸比对/陌生人比对联动配置
    • 客流统计
      • 客流统计参数配置
      • 客流统计参数配置获取
      • 查询客流数据
  • 消息通道
    • 对接指南
    • 消息类型定义
    • 消息通道API
      • 创建消费者
      • 消费消息
      • 提交偏移量
  • 其他设备能力
    • 萤石探测器
      • 获取探测器列表
      • 关联探测器
      • 设置探测器状态
      • 删除探测器
      • 获取可关联的IPC列表
      • 获取已关联的IPC列表
      • 设置探测器与IPC的关联关系
      • 修改探测器名称
      • 一键消警
    • 区域热度
      • 获取区域关注度配置
      • 区域关注度配置
      • 生成热度图
      • 获取热度图
      • 获取热度图配置
      • 设置热度图配置
    • 设备校时
      • 获取设备校时配置
      • 配置设备校时
      • 获取NTP服务器配置
      • 配置NTP服务器
      • 获取指定NTP服务器配置
      • 配置指定NTP服务器参数
    • 萤石云储存
      • 设备开通云存储
      • 开启/关闭云存储
      • 获取设备云存储信息
    • 视频安全帽
      • 设备本地开关权限控制
      • 设备录像开关
      • 设备立即上报按键触发抓图事件
      • 设备立即上报状态信息
      • 设备补光灯开关
      • 设备激光灯开关
    • 报警主机
      • 获取子系统列表
      • 获取防区列表
      • 获取主机状态
      • 获取所有防区状态
      • 子系统布防
      • 子系统撤防
    • 设备布撤防
  • 历史接口
    • 组管理
      • 新增组
      • 修改组
      • 删除组
      • 获取所有组
      • 查找组的下级节点
    • 组管理V2
      • 新增组
      • 修改组
      • 删除组
      • 获取所有组
      • 获取单个组信息
      • 查找组的下级节点
    • 设备管理
      • 注册设备
      • 注销设备
      • 获取设备列表
      • 获取单个设备信息
      • 修改设备名称
      • 获取设备总数
      • 设备布撤防
    • 通道管理
      • 查询设备下通道列表
      • 同步设备下通道
      • 修改通道名称
      • 设备抓图
    • 标准流预览
      • 关闭设备视频加密
      • 开通标准流预览功能
      • 获取标准流预览地址
      • 获取指定有效期标准流预览地址
    • 云台操作
      • 开始云台控制
      • 停止云台控制
      • 添加预置点
      • 调用预置点
      • 清除预置点
    • 门禁管理
      • 门禁管理
        • 人员下发
        • 人员更新
        • 人员查询
        • 人员删除
        • 卡下发
        • 卡更新
        • 卡查询
        • 卡删除
        • 人脸下发
        • 人脸修改
        • 人脸查询
        • 人脸删除
        • 访客二维码生成
        • 远程控门
        • 可视对讲交互事件通知
        • 可视对讲通知地址配置
      • 门禁批量管理
        • 注册人员信息
        • 批量注册人员信息
        • 更新人员信息
        • 查询人员列表
        • 删除人员信息
        • 批量下发
        • 查询任务状态
        • 查询任务详情
      • 门禁计划
        • 计划模板管理
          • 周计划模板添加/更新
          • 周计划模板获取
          • 周计划模板删除
          • 假日计划模板添加/更新
          • 假日计划模板获取
          • 假日计划模板删除
        • 门禁计划管理
          • 周计划配置
          • 周计划获取
          • 假日计划配置
          • 假日计划获取
          • 假日组计划配置
          • 假日组计划获取
          • 门禁计划配置
          • 门禁计划聚合配置
          • 门禁计划获取
          • 清空门禁计划
    • 超脑人脸管理
      • IO管理
        • 获取设备IO端口状态
        • 获取设备指定输出口信息
        • 配置设备指定输出口信息
        • IO输出
      • 人脸管理
        • 删除人脸
        • 查询人脸信息
        • 查询人脸列表
      • 人脸库管理
        • 创建人脸库
        • 查询人脸库容量
        • 删除全部人脸库
        • 删除指定人脸库
        • 查询人脸库基本参数
        • 设置人脸库基本参数
        • 查询指定人脸库基本参数
        • 设置指定人脸库基本参数
        • 查询人脸比对参数
        • 配置人脸比对参数
      • 人员信息管理
        • 注册人员信息
        • 查询人员列表
        • 注销人员信息
      • 获取磁盘基本信息
    • 下发任务管理
      • 下发人脸
      • 任务状态查询
      • 人脸下发状态查询
      • 删除任务
  • 健康码分析能力
    • 健康码识别
    • 行程码识别
    • 核酸报告识别
  • 获取access_token
    POST
  1. 消息通道

消息类型定义

消息类型消息定义
open_event_access门禁事件消息
open_idcard_event人证比对事件
open_access_qrcode_event门禁二维码事件
open_passengerFlow客流消息
open_face_capture人脸抓拍消息
open_event_access_batch_delivered门禁批量下发消息
open_event_super_brain_faces_delivered边缘人脸下发消息
open_event_super_brain_faces_comparison边缘人脸比对消息
open_ezviz_detector_alarm萤石探测器报警消息
open_device_alarm设备报警消息
open_device_onoffline设备上下线消息
open_channel_onoffline通道上下线消息
open_message_anpr车辆抓拍消息
open_message_tma测温报警消息
open_tem_humi_detection温湿度报警消息
open_person_queue_counting区域人数超限报警消息
open_access_auth_sync_result门禁权限下发结果消息
open_async_notification_event异步通知事件
open_safety_helmet_detection安全帽检测事件
open_city_management_event智慧城管事件
open_objects_thrown_detection高空抛物检测事件
open_visitor_event访客事件
ai_message_task_resultAI任务执行结果消息
open_event_user_info_collect人员信息采集消息
open_mixed_target_detection混合目标检测
open_message_parking停车检测
open_message_people_num_change人数变化(人数异常检测)
open_message_faildown人员倒地
open_message_retention人员滞留
open_message_smoke_and_fire烟火检测事件
open_person_density_detection人员密度检测
open_socket_status插座用电量
open_socket_switch_status插座开关状态
open_switch_status智能开关状态
open_play_cellphone玩手机检测事件
open_leave_position离岗检测事件
open_person_queue_timing_statistics区域定时人数统计事件
open_person_queue_realtime区域实时人数检测事件
open_person_queue_time区域人员停留时长检测事件
open_device_drop设备坠落事件
open_device_not_moved设备静止事件
open_device_status设备状态上报事件
open_local_button_snapshot设备按键触发抓图事件
open_ai_video_task_detectionAI视频任务检测事件

门禁事件消息

open_event_access消息格式:

字段名描述类型是否必填
eventId事件IDString是
dateTime事件时间(UTC时间)String是
employeeNo人员IDString否
cardNo卡号String否
deviceSerial设备序列号String是
deviceName设备名称String是
channelNo触发报警的设备通道号String否
channelName触发报警的设备通道名称String否
cardReaderKind读卡器类型:1-IC读卡器,2-身份证读卡器,3-二维码读卡器Integer否
cardReaderNo读卡器编号Integer否
doorNo门编号Integer否
eventType事件类型String是
eventCode事件码String是
eventDescription事件描述String是
eventSource事件来源(目前暂未使用)String否
pictureURL图片URLString否
bodyMaxTemperatureValue人体温度Integer否,需要设备支持测温功能
currTemperature人脸温度Float否,需要设备支持测温功能
healthInfo健康信息Object否,需要设备支持健康码功能
eventRemark备注String否

healthInfo格式

字段名描述类型是否必填
healthCode健康码状态,0#未请求,1#未申领,2#绿码,3#黄码,4#红码,5#无此人员,6#其他错误信息(如接口异常导致查询失败),7#查询健康码超时int否
NADCode核酸检测结果,0#未查询到核酸检测结果,1#核酸检测阴性(代表正常),2#核酸检测阳性(代表确诊),3#核酸检测有效期已过,4#查询核酸结果失败int否
travelCode行程编码,0#14天内一直在当地,1#14天内离开过当地,2#14天内到过疫区,3#其他,4#查询行程信息失败int否
travelInfo行程信息,空表示查询到行程信息失败String否
vaccineStatus打疫苗状态, 0#未打疫苗,1#部分注射疫苗,2#已完成疫苗,3#查询疫苗信息失败,4#已完成加强针疫苗int否
vaccineNum打疫苗针数int否

open_event_access消息示例:

         {
             "eventId": "6514484bc11397508cab7870c633216b",
             "dateTime": "2019-04-10T16:32:42+08:00",
             "employeeNo": "12345",
             "cardNo": "512369",
             "deviceSerial": "123456789",
             "deviceName": "一单元的门口机",
             "channelNo": "1",
             "channelName": "第一通道",
             "eventType": "AccessEvent",
             "eventCode": "10100",
             "eventDescription": "刷卡开锁",
             "eventSource": "active",
             "pictureURL": "https://xxx.jpg",
             "bodyMaxTemperatureValue": 37000,
             "currTemperature": 37.0,
             "healthInfo":{    
                 "healthCode":  1,
                 "NADCode":  1,    
                 "travelCode":  1,
                 "travelInfo":  "test",
                 "vaccineStatus":  1,
                 "vaccineNum":  1
             },
             "eventRemark": "我是备注信息"
         }
        

eventeventCode事件码对照表:

事件码事件描述
10101刷卡开锁
10102组合认证刷卡加密码开锁
10103组合认证刷卡加指纹开锁
10104指纹开锁
10105组合认证刷卡加指纹加密码开锁
10106组合认证指纹加密码开锁
10107组合认证人脸加指纹开锁
10108组合认证人脸加密码开锁
10109组合认证人脸加刷卡开锁
10110组合认证人脸加密码加指纹开锁
10111组合认证人脸加刷卡加指纹开锁
10112组合认证工号加指纹开锁
10113组合认证工号加指纹加密码开锁
10114人脸开锁
10115组合认证工号加人脸开锁
10116户主开锁
10117组合认证工号加密码开锁
10118人证开锁
10119蓝牙开锁
10120密码开锁
10121组合认证
10122二维码开锁
10123户主开锁
10124中心平台开锁
10125人脸认证失败
10126黑名单人员事件
10127门锁常开开始
10128门锁常开结束
10129门异常打开(门磁)
10130无效时段
10131门锁打开
10132门锁关闭
10133不属于多重认证群组
10134不在多重认证时间段内
10135多重认证成功
10136多重认证重复认证事件
10137多重认证超时
51034胁迫报警

人证比对事件

open_idcard_event格式定义:

字段名描述类型是否必填
deviceSerial设备序列号String是
eventType人证比对结果,105:人证比对通过 112:人证比对失败Integer是
eventTime事件时间:yyyy-MM-ddTHH:mm:ss+ZString是
currentEvent是否实时事件Boolean是
pictureURL抓拍图片urlString否
idcardPicURL身份证图片urlString是
idcardInfo身份证信息Object是
healthInfo健康信息Object否,需要设备支持健康码功能

idcardInfo字段格式定义:

字段名描述类型是否必填
name姓名String是
sex性别,male-男,female-女String是
birth生日,格式yyyy-MM-ddString是
addr地址String是
idcardNo身份证号String是
issuingAuthority签发机关String是
startDate起始日期,格式yyyy-MM-ddString是
endDate结束日期,格式yyyy-MM-ddString是
isLongTermEffective是否长期有效String是
nation民族,1-“汉”,2-“蒙古”,3-“回”,4-“藏”,5-“维吾尔”,6-“苗”,7-“彝”,8-“壮”,9-“布依”,10-“朝鲜”,11-“满”,12-“侗”,13-“瑶”,14-“白”,15-“土家”,16-“哈尼”,17-“哈萨克”,18-“傣”,19-“黎”,20-“傈僳”,21-“佤”,22-“畲”,23-“高山”,24-“拉祜”,25-“水”,26-“东乡”,27-“纳西”,28-“景颇”,29-“柯尔克孜”,30-“土”,31-“达斡尔”,32-“仫佬”,33-“羌”,34-“布朗”,35-“撒拉”,36-“毛南”,37-“仡佬”,38-“锡伯”,39-“阿昌”,40-“普米”,41-“塔吉克”,42-“怒”,43-“乌孜别克”,44-“俄罗斯”,45-“鄂温克”,46-“德昂”,47-“保安”,48-“裕固”,49-“京”,50-“塔塔尔”,51-“独龙”,52-“鄂伦春”,53-“赫哲”,54-“门巴”,55-“珞巴”,56-“基诺”,57及之后为未知String是

healthInfo格式

字段名描述类型是否必填
healthCode健康码状态,0#未请求,1#未申领,2#绿码,3#黄码,4#红码,5#无此人员,6#其他错误信息(如接口异常导致查询失败),7#查询健康码超时int否
NADCode核酸检测结果,0#未查询到核酸检测结果,1#核酸检测阴性(代表正常),2#核酸检测阳性(代表确诊),3#核酸检测有效期已过,4#查询核酸结果失败int否
travelCode行程编码,0#14天内一直在当地,1#14天内离开过当地,2#14天内到过疫区,3#其他,4#查询行程信息失败int否
travelInfo行程信息,空表示查询到行程信息失败String否
vaccineStatus打疫苗状态, 0#未打疫苗,1#部分注射疫苗,2#已完成疫苗,3#查询疫苗信息失败,4#已完成加强针疫苗int否
vaccineNum打疫苗针数int否

open_idcard_event示例:

         {
             "deviceSerial": "123456789",
             "eventType": 112,
             "eventTime": "2019-07-26T16:06:12+08:00",
             "currentEvent": false,
             "idcardPicURL": "https://open.ys7.com/api/lapp/mq/downloadurl?appKey=***&fileKey=ISAPI_FILES/D03920393_2/20190726163814955-D03920393-2-10000$encrypt=2,2019-07-26T16:35:59,***",
             "idcardInfo": {
                 "name": "张三",
                 "sex": "male",
                 "birth": "1995-07-03",
                 "addr": "XX省XX市XX县XX镇XX村XX号",
                 "issuingAuthority": "重庆市公安局永川分局",
                 "startDate": "2016-04-14",
                 "endDate": "2026-04-14",
                 "nation": 1,
                 "isLongTermEffective": "false",
                 "idcardNo": "123456789xx"
              },
             "healthInfo":{    
                 "healthCode":  1,
                 "NADCode":  1,    
                 "travelCode":  1,
                 "travelInfo":  "test",
                 "vaccineStatus":  1,
                 "vaccineNum":  1
             }
         }
        

门禁二维码事件

open_access_qrcode_event 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime事件时间(UTC时间)String是
serialNo事件流水号Integer是
deviceName设备名称String是
QRCodeInfo二维码信息String是
thermometryUnit测温单位:celsius-摄氏度(默认),fahrenheit-华氏度,kelvin-开尔文String否
currTemperature人脸温度:精确到小数点后一位Float否
regionCoordinates人脸温度坐标Object否
remoteCheck是否需要远程核验:true-需要,false-不需要(默认)Boolean否
visibleLightURL热成像相机可见光图片URLString否
thermalURL热成像图片URLString否
pictureURL抓拍图片URLString否
healthInfo健康信息Object否,需要设备支持健康码功能

regionCoordinates字段格式

字段名描述类型是否必填
positionXX坐标,归一化坐标0-1000Integer否
positionYY坐标,归一化坐标0-1000Integer否

healthInfo格式

字段名描述类型是否必填
healthCode健康码状态,0#未请求,1#未申领,2#绿码,3#黄码,4#红码,5#无此人员,6#其他错误信息(如接口异常导致查询失败),7#查询健康码超时int否
NADCode核酸检测结果,0#未查询到核酸检测结果,1#核酸检测阴性(代表正常),2#核酸检测阳性(代表确诊),3#核酸检测有效期已过,4#查询核酸结果失败int否
travelCode行程编码,0#14天内一直在当地,1#14天内离开过当地,2#14天内到过疫区,3#其他,4#查询行程信息失败int否
travelInfo行程信息,空表示查询到行程信息失败String否
vaccineStatus打疫苗状态, 0#未打疫苗,1#部分注射疫苗,2#已完成疫苗,3#查询疫苗信息失败,4#已完成加强针疫苗int否
vaccineNum打疫苗针数int否

open_access_qrcode_event消息示例:

         {
             "deviceSerial": "123456789",
             "dateTime": "2020-03-05T14:53:19+08:00",
             "serialNo": 159,
             "deviceName": "一单元门口机",
             "QRCodeInfo": "https://xxx.com/123.jpg",
             "thermometryUnit": "celsius",
             "currTemperature": "36.4",
             "regionCoordinates": {
                 "positionX": 362,
                 "positionX": 500
             },
             "remoteCheck": true,
             "pictureURL": "https://xxx.com/123.jpg",
             "healthInfo":{    
                 "healthCode":  1,
                 "NADCode":  1,    
                 "travelCode":  1,
                 "travelInfo":  "test",
                 "vaccineStatus":  1,
                 "vaccineNum":  1
             }
         }
        

客流消息

open_passengerFlow消息格式:

字段名描述类型是否必填
id客流消息idString是
deviceSerial设备序列号String是
startTime统计开始时间String是
endTime统计结束时间String是
enterNum进入人数Integer是
leaveNum离开人数Integer是
passNum经过人数Integer否
messsagTime消息处理时间String是

消息示例:

         {
             "id": "12345",
             "deviceSerial": "123456789",
             "startTime": "2019-02-28T13:30:00",
             "endTime": "2019-02-28T13:35:00",
             "enterNum": 1,
             "leaveNum": 0,
             "passNum": 0,
             "messageTime": "2019-02-28T13:37:22"
         }
        

人脸抓拍消息

open_face_capture消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
faceCapture人脸抓拍数据List是

faceCapture格式:

字段名描述类型是否必填
faceTime抓拍时间,格式yyyy-MM-ddTHH:mmZString是
bkgUrl背景图地址String是
thermalURL热成像图片地址String否
faces人脸数据List是

faces格式:

字段名描述类型是否必填
faceRect人脸坐标Object是
faceScore人脸评分Integer是
stayDuration停留时长,单位毫秒Integer否
faceUrl人脸图地址String是
mask口罩检测Object否
targetID人脸关联IDString否
faceSnapThermometryEnabled人脸抓拍测温使能Boolean否
currTemperature人脸温度Double否
isAbnomalTemperature人脸温度是否异常Boolean否
thermometryUnit测温单位,celsius:摄氏度,fahrenheit:华氏度,kelvin:开尔文String否

faceRect格式:

字段名描述类型是否必填
x横坐标Double是
y纵坐标Double是
width人脸宽度Double是
height人脸高度Double是

注:坐标均为相对比例值

mask字段格式:

字段名描述类型是否必填
confidence置信度Double否
valueyes-戴口罩,no-不戴口罩,unknown-未知String否

open_face_capture消息示例:

         {
             "deviceSerial": "123456789",
             "faceCapture": [{
                 "faceTime": "2019-08-05T18:43Z",
                 "bkgUrl": "https://bkgUrl",
                 "faces": [{
                     "faceRect": {
                         "x": 0.843,
                         "y": 0.3,
                         "width": 0.065,
                         "height": 0.136
                     },
                     "faceScore": 20,
                     "stayDuration": 2000,
                     "faceUrl": "https://faceUrl",
                     "mask": {
                         "confidence":99.99,
                         "value": "yes"
                     },
                     "faceSnapThermometryEnabled": true,
                     "currTemperature": 36.1,
                     "isAbnomalTemperature": false,
                     "thermometryUnit": "celsius"
                 }]
             }]
         }
        

门禁批量下发消息

消息协议字段说明:

字段名描述类型是否为空
taskId任务ID,对应下发时返回的任务IDString否
taskName任务名称,由系统生成String否
isusedTime下发时间LocalDateTime否
totalPersonNum下发总人数Integer否
totalDeviceNum下发总设备数Integer否
taskStatus任务状态(2:下发中;3:已完成;4:中断)Integer否

门禁批量下发消息协议:

         {
             "taskId": "9514484bc14397508cab7870c6332162",
             "taskName": "批量下发结果_20200910",
             "isusedTime": "2019-02-28T13:37:22",
             "totalPersonNum": 1,
             "totalDeviceNum": 1,
             "taskStatus": 2
         }
        

边缘人脸下发消息

人脸下发结果消息字段说明:

         {
             deviceSerial:设备序列号
             customFaceLibId:自定义人脸库ID
             taskId:任务ID
             status:状态(success-成功,failure-失败)
             message:状态描述(失败原因等)
         }
        

人脸下发结果消息协议:

         {
             "deviceSerial": "xxxxxxxxxx",
             "customFaceLibId": "888888",
             "taskId": "xxxxxxxxxx",
             "status": "success/failure",
             "message": "xxxxxxxx"
         }
        

边缘人脸比对消息

协议字段说明:

  • code: 当人脸图片分析失败时,会返回对应的错误码,int。!!!该字段仅对定制设备生效,标准设备不返回该字段
  • msg: 当人脸图片分析失败时,会返回对应的错误信息,string。!!!该字段仅对定制设备生效,标准设备不返回该字段
  • dateTime:事件时间,格式:2004-05-03T17:30:08+08:00
  • deviceSerial: 设备序列号
  • channelNo:通道号,Integer类型
  • targetAttrs: 目标属性
    • faceTime:抓拍时间,格式:2004-05-03T17:30:08+08:00
    • bkgUrl:背景大图URL, string类型, 最大长度为256
  • faces:人脸信息包括检测结果、属性、建模和匹配名单, 一张图片中的可能多个人脸结果, array数组
    • url:人脸小图URL,最大长度为256
    • prompt:人脸库比对提示语
    • contrastStatus:比对结果,boolean类型。true表示比对成功,false表示比对失败
    • realTimeContrast:是否实时比对,boolean类型
    • faceRect:人脸小图矩形框,用于参数建模
      • height:高度, float类型
      • width:宽度, float类型
      • x:X坐标, float类型
      • y:Y坐标, float类型
    • identify:
      • maxsimilarity:可选, 所有匹配人员比对结果中的最大相似度, 取值范围: 0~1, 精确到小数点后两位, float类型
      • similarityRange:可选, 相似度范围,integer,0:低于min, 1:min-max之间, 2:大于max
      • candidate:匹配的人员名单信息列表, 同一个布防关联对应多个匹配人员, array数组
        • similarity:该人员所有匹配人脸图片结果中的最大相似度, 取值范围:0~1, 精确到小数点后两位, float类型
        • faceLibName:人脸库名称
        • faceLibThreshold:人脸库检测阈值,范围[0-100]
        • customFaceLibId:自定义人脸库ID
        • employeeNo: 自定义人员ID
        • reserveField:保留字节(透传数据), 最大不超过256字节, 若下发的数据超过此会产生截断
          • name:姓名, string类型, 最大长度为96字节
          • gender:性别: male-男, female-女, unknown-未知, string类型, 最大长度为10
          • bornTime:出生日期, ISO8601 time格式, string类型, 最大长度为32
          • city:人员出生城市编号(详见:全国各省份城市列表), string类型, 最大长度为32
          • certificateType:证件类型: officerID-军官证, ID-身份证, passport-护照, other-其他, string类型, 最大长度为10
          • certificateNumber:证件号, string类型, 最大长度为32
          • ageGroup:年龄段: unknown-未知, 详见属性参数取值字典, string类型, 最大长度为32
          • phoneNumber:电话号码, string类型, 最大长度为64
        • humanData:人员数据,array数组
          • facePicUrl:人脸图片url,最大长度为256
          • similarity:人脸图片最大相似度, 取值范围:0~1, 精确到小数点后两位, float类型
          • faceId:人脸ID,可以为空
          • faceRect:矩形框,用于参数建模
            • height:高度, float类型
            • width:宽度, float类型
            • x:X坐标, float类型
            • y:Y坐标, float类型
    • faceProperties:人脸属性信息
      • age:年龄,可选
        • range:可选, 年龄偏差, 年龄偏差值存在时年龄值必填, integer32类型
        • value:可选, 年龄, integer32类型
        • ageGroup:可选, 年龄段: unknown-未知, child-少年, young-青年, middle-中年, old-老年, string类型, 最大长度为32
      • gender:可选, 性别
        • confidence:可选, 置信度, float类型
        • value:可选, 性别: male-男, female-女, unknown-未知, string类型, 最大长度为32
      • glass:可选, 是否戴眼镜
        • confidence:可选, 置信度, float类型
        • value:可选, 是否戴眼镜: no-不戴眼镜, yes-戴眼镜-sunglasses-戴墨镜, string类型, 最大长度为32
      • smile:可选, 是否微笑
        • confidence:可选, 置信度, float类型
        • value:可选, 是否微笑: no-不微笑, yes-微笑, string类型, 最大长度为32
      • ethnic:可选, 是否少数民族
        • confidence:可选, 置信度, float类型
        • value:可选, 是否少数民族: no-不是, yes-是, string类型, 最大长度为32
      • beard:可选, 是否大胡子
        • confidence:可选, 置信度, float类型
        • value:可选, 是否大胡子: no-不是, yes-是, string类型, 最大长度为32
      • mask:可选, 是否戴口罩
        • confidence:可选, 置信度, float类型
        • value:可选, 是否戴口罩: no-不是, yes-是, string类型, 最大长度为32
      • faceExpression:可选, 表情
        • confidence:可选, 置信度, float类型
        • value:可选, 表情类型: 详见数据字典, string类型, 最大长度为32
      • race:可选, 人种
        • confidence:可选, 置信度, float类型
        • value:可选, 人种类型: 亚洲人:asians;黑人:black;白人: white;未知:unknown, string类型, 最大长度为32
      • hat:可选, 帽子
        • confidence:可选, 置信度, float类型
        • value:可选, 不戴帽子:no;带帽子:yes;未知:unknown, string类型, 最大长度为32
    • temperature:人脸测温信息
      • faceSnapThermometryEnabled:可选, 人脸抓拍测温使能,boolean类型
      • currTemperature:可选, 人脸温度(-20.0℃~150.0℃,精确到小数点后1位),float类型
      • thermometryUnit:可选,测温单位(”celsius”摄氏度,”fahrenheit”华氏度,”kelvin”开尔文), string类型
      • isAbnomalTemperature:可选,人脸抓拍测温是否温度异常(true-是,false-否), boolean类型

人脸比对消息协议:

         [
             {
                 "code": 1,
                 "msg": "ok", 
                 "dateTime": "2020-10-03T17:30:08+08:00",
                 "deviceSeiral": "123456789", 
                 "channelNo": 1, 
                 "targetdAttrs": {
                     "faceTime": "2020-10-03T17:30:08+08:00",
                     "bkgUrl": "http://absddsdfsdfsdk"
                 }, 
                 "faces": [
                     {
                         "faceId": 1, 
                         "faceRect": {
                             "height": 1, 
                             "width": 1, 
                             "x": 0, 
                             "y": 0
                         }, 
                         "url": "http://absddsdfsdfsdk", 
                         "identify": [
                             {
                                 "maxsimilarity": 60, 
                                 "similarityRange": 1, 
                                 "candidate": [
                                     {
                                         "reserveField": {
                                             "name": "张三", 
                                             "gender": "male", 
                                             "bornTime": "2004-05-03", 
                                             "city": "130100", 
                                             "certificateType": "ID", 
                                             "certificateNumber": "xxxxxxxxxx", 
                                             "ageGroup": "old", 
                                             "phoneNumber": "ssssssssssss"
                                         }, 
                                         "similarity": 0.78, 
                                         "faceLibName": "faceLib1", 
                                         "faceLibThreshold": 50, 
                                         "customFaceLibId": "", 
                                         "employeeNo": "", 
                                         "humanData": [
                                             {
                                                 "facePicUrl": "http://absddsdfsdfsdk-58264-D59555425-1-10000", 
                                                 "similarity": 0.98
                                             }
                                         ]
                                     }
                                 ]
                             }
                         ], 
                         "faceProperties": {
                             "age": {
                                 "ageGroup": "young"
                             }, 
                             "gender": {
                                 "value": "male"
                             }, 
                             "glass": {
                                 "value": "yes"
                             }, 
                             "smile": {
                                 "value": "yes"
                             }, 
                             "mask": {
                                 "value": "no"
                             }
                         }, 
                         "temperature": {
                             "faceSnapThermometryEnabled": true, 
                             "currTemperature": 36.3, 
                             "thermometryUnit": "celsius", 
                             "isAbnomalTemperature": false
                         }
                     }
                 ]
             }
         ]
        

萤石探测器报警消息

open_ezviz_detector_alarm消息格式:

字段名描述类型是否必填
alarmTime报警时间String是
channel通道号Integer是
channelType通道类型Integer是
relationId关联IDString是
customInfo定制信息String是
requestTime请求时间Long是
devSerial设备序列号String是
alarmType报警类型String是
customType定制类型String是
alarmId报警IDString是
channelName通道名称String是
location探测器名称String是
describe描述String是
pictureList报警图片(由探测器关联的IPC上报)String是
status状态Integer是

消息示例:

         {
             "alarmTime": "2019-10-16T17:20:43",
             "channel": 0,
             "channelType": 1,
             "relationId": "",
             "customInfo": "sn=099336174^cn=1",
             "requestTime": 1571217644756,
             "devSerial": "718152937",
             "alarmType": "infrared",
             "customType": "CS-A1C-32W_01",
             "alarmId": "49d10f48-1dd2-11b2-837c-b783b0443e29",
             "channelName": "A1C(718152937) 测试红外探测器Aa",
             "location": "测试红外探测器Aa",
             "describe": "infrared",
             "pictureList": [],
             "status": 1
         }
        

设备报警消息

open_device_alarm消息格式:

字段名描述类型是否必填
alarmTime报警时间String是
channel通道号Integer是
channelType通道类型Integer是
relationId关联IDString否
customInfo定制信息String否
requestTime请求时间Long是
devSerial设备序列号String是
alarmType报警类型String是
customType定制类型String否
alarmId报警IDString是
channelName通道名称String是
location位置信息String否
describe描述String否
pictureList报警图片List是
status状态Integer是

pictureList字段:

字段名描述类型是否必填
shortUrl图片路径String否
id图片IDString是
url图片完整路径String是

消息示例:

         {
             "alarmTime": "2019-09-20T17:14:06",
             "channel": 1,
             "channelType": 1,
             "relationId": "",
             "customInfo": "",
             "requestTime": 1568970848568,
             "devSerial": "D59999804",
             "alarmType": "leftdetection",
             "customType": "",
             "alarmId": "0d95ece8-dbca-11e9-8000-ec685df39ac6",
             "channelName": "DS-2CD2626FWDA2-IZS(D59999804)",
             "location": "",
             "describe": "leftdetection",
             "pictureList": [
                 {
                     "shortUrl": "https://i.ys7.com/c/e2HsqF6_e",
                     "id": "20190920171407-D59999804-1-10023-2-1",
                     "url": "https://i.ys7.com/xxxx"
                 }
             ],
             "status": 1
         }
        

设备上下线消息

open_device_onoffline消息格式:

字段名描述类型是否必填
groupId组IDString是
deviceId设备IDString是
deviceSerial设备序列号String是
devType设备类型String是
regTime注册时间String是
natIp设备IPString是
msgType消息类型:ONLINE-上线,OFFLINE-下线String是
subSerial子序列号String是
occurTime事件发生时间String是
deviceName设备名称String是

消息示例:

         {
             "groupId":"xxx",
             "deviceId":"XXX",
             "deviceSerial":"xxx",
             "devType": "CS-A1C-32W",
             "regTime": "2019-10-14 19:51:24",
             "natIp": "115.236.50.15",
             "msgType": "ONLINE",
             "subSerial": "718152937",
             "occurTime": "2019-10-14 19:51:24",
             "deviceName": "A1C(718152937)"
         }
        

通道上下线消息

open_channel_onoffline 消息格式:

字段名描述类型是否必填
superDeviceNVR设备序列号String是
type类型:VIDEO-视频String是
sendTime发送时间String是
slaves通道信息String是

slaves字段说明

字段名描述类型是否必填
devType设备型号String是
selfDevSerialIPC完整设备序列号String是
superDevChannelNVR通道号int是
selfDevSubserialIPC设备序列号String是
superDevSerialNVR设备序列号String是
type通道类型:V-视频String是
status在线状态:0-离线,1-在线int是

消息示例:

         {
             "slaves": [
                 {
                     "devType": "DS-2CD2646FWDA2-IZS",
                     "selfDevSerial": "DS-2CD2646FWDA2-IZS20190424AACHD13455058",
                     "superDevChannel": 1,
                     "selfDevSubserial": "D13455058",
                     "superDevSerial": "C14842557",
                     "type": "V",
                     "status": 1
                 },
                 {
                     "devType": "other",
                     "selfDevSerial": "C14842557-2",
                     "superDevChannel": 2,
                     "selfDevSubserial": "C14842557-2",
                     "superDevSerial": "C14842557",
                     "type": "V",
                     "status": 0
                 },
                 {
                     "devType": "DS-2CD7127FWD/H-IZ",
                     "selfDevSerial": "DS-2CD7127FWD/H-IZ20180802AACHC39747644",
                     "superDevChannel": 3,
                     "selfDevSubserial": "C39747644",
                     "superDevSerial": "C14842557",
                     "type": "V",
                     "status": 1
                 },
                 {
                     "devType": "other",
                     "selfDevSerial": "C14842557-4",
                     "superDevChannel": 4,
                     "selfDevSubserial": "C14842557-4",
                     "superDevSerial": "C14842557",
                     "type": "V",
                     "status": 0
                 }
             ],
             "superDevice": "C14842557",
             "type": "VIDEO",
             "sendTime": "2019-10-28 15:42:23"
         }
        

车辆抓拍消息

open_message_anpr消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime抓拍时间String是
anpr车辆识别数据Object是
uuid通用唯一识别码String否
picNum图片数量Integer否
deviceName设备名称String否
monitoringSiteID监测点编号String否

anpr格式:

字段名描述类型是否必填
licensePlate车牌号码String是
line识别车道号Integer是
confidenceLevel置信度等级,[0,100]Integer是
plateType车牌类型String否
plateColor车牌颜色String否
licenseBright车牌亮度值[0~255]Integer否
plateCharBelieve各个识别字符的置信度String否
speedLimit限速上限,超速时有效Integer否
vehicleType车辆类型String是
detectType检测方式,0-车辆检测,1-地感触发,2-视频触发,3-多帧识别,4-雷达触发,5-混行检测Integer否
dwIllegalTime违法持续时间(ms)=抓拍最后一张图片的时间-抓拍第一张图片的时间Integer否
vehicleInfo车辆信息Object是
pictureInfoList抓拍图片信息List是

vehicleInfo格式:

字段名描述类型是否必填
index车辆序号Integer是
vehicleType车辆类型,0 表示其它车型,1 表示小型车,2 表示大型车,3表示行人触发,4表示二轮车触发,5表示三轮车触发 6表示机动车触发Integer否
colorDepth车身颜色深浅,0-深色,1-浅色Integer是
color车身颜色String是
speed车辆速度,单位km/hInteger否
length前一辆车的车身长度,单位分米dmInteger是
vehicleLogoRecog车辆主品牌Integer是
vehileSubLogoRecog车辆子品牌Integer否
vehileModel车辆子品牌年款Integer否

pictureInfoList格式:

字段名描述类型是否必填
fileName图片名称String是
type图片类型String是
dataType0,数据上传;1,URL上传Integer是
absTime绝对时间点,格式:yyyyMMddHHmmssxxx,e.g.20090810235959999 最后三位为毫秒数String否
plateRect车牌坐标,数值为当前画面的百分比大小*1000,精度为小数点后三位,当type=detectionPicture时生效Object否
vehicelRect车辆坐标,数值为当前画面的百分比大小*1000,精度为小数点后三位,当type=detectionPicture时生效Object否
pictureURL图片URLString否

plateRect、vehicelRect格式

字段名描述类型是否必填
x横坐标Integer是
y纵坐标Integer是
width人脸宽度Integer是
height人脸高度Integer是

open_message_anpr消息示例:

         {
             "deviceSerial": "123456789", 
             "dateTime": "2019-11-26T11:08:22+08:00", 
             "anpr": {
                 "licensePlate": "蓝浙A12345", 
                 "line": 1, 
                 "confidenceLevel": 0, 
                 "plateType": "unknown", 
                 "plateColor": "blue", 
                 "licenseBright": 0, 
                 "plateCharBelieve": "", 
                 "speedLimit": 0, 
                 "vehicleType": "vehicle", 
                 "detectType": 0, 
                 "dwIllegalTime": 0, 
                 "vehicleInfo": {
                     "index": 1090, 
                     "vehicleType": 0, 
                     "colorDepth": 1, 
                     "color": "white", 
                     "speed": 0, 
                     "length": 0, 
                     "vehicleLogoRecog": 1083, 
                     "vehileSubLogoRecog": 59, 
                     "vehileModel": 1
                 }, 
                 "pictureInfoList": [
                     {
                         "fileName": "licensePlatePicture.jpg", 
                         "type": "licensePlatePicture", 
                         "dataType": 0, 
                         "absTime": "20191126110822334", 
                         "pictureURL": "https://xxxxxxxxx"
                     }, 
                     {
                         "fileName": "detectionPicture.jpg", 
                         "type": "detectionPicture", 
                         "dataType": 0, 
                         "absTime": "20191126110822334", 
                         "plateRect": {
                             "x": 0, 
                             "y": 0, 
                             "width": 0, 
                             "height": 0
                         }, 
                         "pictureURL": "https://xxxxxxxx"
                     }
                 ]
             }, 
             "uuid": "xxxxxxxxx", 
             "picNum": 2, 
             "deviceName": "Camera 01", 
             "monitoringSiteID": ""
         }
        

测温报警消息

open_message_tma格式定义:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime事件时间:yyyy-MM-ddTHH:mm:ss+ZString是
detectionRegionList检测区域列表List否
channelName通道名称String否
detectionPicturesNumber图片个数Integer否
visibleLightURL可见光图片URLString否
thermalURL热成像图片URLString否

detectionRegionList内对象格式定义:

字段名描述类型是否必填
regionID规则区域IDInteger是
regionCoordinatesList规则区域坐标List是
tma测温信息Object是

regionCoordinatesList内对象格式定义:

字段名描述类型是否必填
positionXX坐标 归一化坐标0-1000Integer是
positionYY坐标 归一化坐标0-1000Integer是

tma格式定义:

字段名描述类型是否必填
thermometryUnit测温单位 “celsius”摄氏度,”fahrenheit”华氏度,”kelvin”开尔文String否
ruleTemperature配置规则温度Double否
currTemperature当前温度Double否
ruleCalibType规则标定类型 “region”区域(框),”line”线,”point”点String否
ruleType报警类型:”highest temp is higher than”高温大于 “lowest temp is higher than”低温大于 “average temp is higher than”平均温大于 “temp diff is higher than”温差大于 “highest temp is lower than”高温小于 “lowest temp is lower than”低温小于 “average temp is lower than”平均温小于 “temp diff is lower than”温差小于String否
maximumTemperaturePoint线、框测温最高温度位置坐标Object否
absoluteHigh设备PTZ值Object否

maximumTemperaturePoint格式定义:

字段名描述类型是否必填
regionCoordinates坐标信息,格式同regionCoordinatesList内对象Object否

absoluteHigh格式定义:

字段名描述类型是否必填
elevationT值,方位角Float否
azimuthP值,俯仰角Float否
absoluteZoomZ值,变倍值Float否

open_message_tma示例:

         {
            "deviceSerial": "123456789", 
            "dateTime": "2020-02-16T00:30:28+08:00", 
            "activePostCount": 5918, 
            "detectionRegionList": [
                {
                    "regionID": 2, 
                    "regionCoordinatesList": [
                        {
                            "positionX": 478, 
                            "positionY": 933
                        }, 
                        {
                            "positionX": 497, 
                            "positionY": 933
                        }, 
                        {
                            "positionX": 497, 
                            "positionY": 975
                        }, 
                        {
                            "positionX": 478, 
                            "positionY": 975
                        }
                    ], 
                    "tma": {
                        "thermometryUnit": "celsius", 
                        "ruleTemperature": 30, 
                        "currTemperature": 35.9, 
                        "ruleCalibType": "region", 
                        "ruleType": "highest temp is higher than", 
                        "maximumTemperaturePoint": {
                            "regionCoordinates": {
                                "positionX": 484, 
                                "positionY": 975
                            }
                        }, 
                        "absoluteHigh": {
                            "elevation": 0, 
                            "azimuth": 0, 
                            "absoluteZoom": 0.1
                        }
                    }
                }
            ], 
            "channelName": "Camera 02", 
            "detectionPicturesNumber": 2, 
            "visibleLightURL": "https://xxx", 
            "thermalURL": "https://xxx"
         }
        

温湿度报警消息

open_tem_humi_detection消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime检测时间String是
temHumiDetection温湿度信息List是

temHumiDetection格式:

字段名描述类型是否必填
byTempOverlimitType温度超阀类型,0-没有超阀 1-超上阀 2-超下阀Integer否
byHumiOverlimitType湿度超阀类型,0-没有超阀 1-超上阀 2-超下阀Integer否
currTemperature温度值,单位摄氏度,实际值精确到0.1,这里传输的值是乘以10后的值Double否
currHumidity湿度值,实际值精确到0.1,这里传输的值是乘以10后的值Double否
ImageURL温湿度图URL,超阀报警时有,实时报警时无String否

open_tem_humi_detection消息示例:

         {
             "deviceSerial": "C81133734", 
             "dateTime": "2020-10-15T17:30:08+08:00", 
             "temHumiDetection":[
                 {
                     "byTempOverlimitType":0,
                     "byHumiOverlimitType":0,
                     "currTemperature": 297,
                     "currHumidity": 497,
                     "ImageURL":""
                 }
             ]
         }
        

区域人数超限报警

open_person_queue_counting消息格式:

字段名描述类型是否必填
headerObject是
bodyObject是

header字段说明

字段名描述类型是否必填
deviceSerial设备序列号String是

body字段说明

字段名描述类型是否必填
payloadObject是

payload字段说明

字段名描述类型是否必填
channelNo通道号Integer是
dateTime时间String是
deviceName设备名称String是
RegionCapture区域热度信息Object是

RegionCapture字段说明

字段名描述类型是否必填
humanCountingObject是
ruleObject是

humanCounting字段说明

字段名描述类型是否必填
count统计人数Integer是

rule字段说明

字段名描述类型是否必填
ruleID规则IDInteger是
alarmCount报警人数Integer是
regionColor区域颜色String是
Region区域坐标信息Object是

消息示例:

         {
             "header": {
                 "deviceSerial": "C39747644"
             }, 
             "body": {
                 "payload": {
                     "channelNo": 1, 
                     "dateTime": "2019-06-03T15:45Z", 
                     "deviceName": "test0123", 
                     "RegionCapture": {
                         "humanCounting": {
                             "count": 5
                         }, 
                         "rule": {
                             "ruleID": 1, 
                             "alarmCount": 1, 
                             "regionColor": "yellow", 
                             "Region": [
                                 {
                                     "x": 0.059, 
                                     "y": 0.046
                                 }, 
                                 {
                                     "x": 0.104, 
                                     "y": 0.925
                                 }, 
                                 {
                                     "x": 0.931, 
                                     "y": 0.945
                                 }, 
                                 {
                                     "x": 0.924, 
                                     "y": 0.093
                                 }
                             ]
                         }
                     }, 
                     "contentID": "background_image"
                 }
             }
         }
        

门禁权限下发结果消息

open_access_auth_sync_result 消息格式:

字段名描述类型是否必填
statisticsId结果统计IDString是
permissionGroupId权限组ID(如果同步方式为0-按租户同步所有权限,那么permissionGroupId为空字符串)String是
syncType同步类型(0-自动同步,1-手动同步)Integer是
syncMode同步方式(0-按租户同步所有权限,1-按权限组同步权限)Integer是
syncStatus同步状态(0-同步成功,1-同步失败)Integer否
syncTime下发(同步)时间(+8:00时区时间)String否
finishTime完成时间String是
totalDeviceNum设备数量Integer是
totalPersonNum人员数量Integer否

open_access_auth_sync_result 消息示例:

         {
             "statisticsId": "71764e91152b44ef8be77b5e525102a9",
             "permissionGroupId": "d14260d4e134406db585e1d06166cce9",
             "syncType": 0,
             "syncStatus": 0,
             "syncMode":0, 
             "syncTime": "2020-05-24T17:20:21+08:00",
             "finishTime": "2020-05-24T17:21:16+08:00",
             "totalDeviceNum": 1,
             "totalPersonNum": 1
         }
        

广告素材下发成功失败消息

open_async_notification_event 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime事件时间:yyyy-MM-ddTHH:mm:ss+ZString是
eventType事件类型:asyncNotificationString是
syncTime下发(同步)时间(+8:00时区时间)String否
channelNo通道号Integer是
currentEvent是否为实时事件,ture-是(实时事件),false-否(离线事件)Boolean否
serialNo事件流水号Integer否
frontSerialNo上一条事件流水号(若设备没返回该字段,平台根据serialNo判断是否丢失事件;若设备返回该字段,平台根据该字段和serialNo字段共同判断是否丢失事件)(主要用于解决报警订阅后导致serialNo不连续的情况)Integer否
details通知详情Object是

details 字段说明

字段名描述类型是否必填
operationmaterialUpload –素材上传String是
requestURL请求URLString是
id素材IDInteger是
status状态:opt=”timeout,failed,success”String是

open_async_notification_event 消息示例:

         {
             "deviceSerial": "D54593713", 
             "dateTime": "2004-05-03T17:30:08+08:00", 
             "eventType": "asyncNotification", 
             "channelNo": 1, 
             "currentEvent": true, 
             "serialNo": 2, 
             "frontSerialNo": 1, 
             "details": {
                 "operation": "materialUpload", 
                 "requestURL": "/ISAPI/Publish/MaterialMgr/material", 
                 "id": 1, 
                 "status": "success"
             }
         }
        

安全帽检测事件

open_safety_helmet_detection消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelNo通道号Integer是
dateTime抓拍时间String是
target安全帽检测数据List是
imageURL背景大图String否

target格式:

字段名描述类型是否必填
recognitionType识别类型, safetyHelmet—安全帽检测String是
TargetInfo安全帽检测信息Object是
rect安全帽矩形框List否
safetyHelmetURL未佩戴安全帽小图urlString否
pId事件唯一IDString否
Face人脸信息Object否
FaceList人脸信息列表List否

TargetInfo格式:

字段名描述类型是否必填
recognition识别类型, safetyHelmet—安全帽检测String是
dataSource检测数据来源[timing:定时,trigger:触发(超过设置的等级限制)]String是

rect格式

字段名描述类型是否必填
x横坐标Integer是
y纵坐标Integer是
width人脸宽度Integer是
height人脸高度Integer是

Face格式

字段名描述类型是否必填
FDID人脸库IDString是
FPID人脸记录IDString是
contentID抓拍人脸匹配到的库图片contentIDString是
pId抓拍人脸匹配到的库图片IDString是
libFacePicURL抓拍人脸匹配到的库图片urlString是

FaceList

字段名描述类型是否必填
FDID人脸库IDString是
FPID人脸记录IDString是
contentID抓拍人脸匹配到的库图片contentIDString是
pId抓拍人脸匹配到的库图片IDString是
name人员姓名String是
certificateType证件类型String是
certificateNumber证件号String是

open_safety_helmet_detection消息示例:

         {
             "deviceSerial": "123456789", 
             "channelNo": 1, 
             "dateTime": "2019-11-26T11:08:22+08:00", 
             "imageURL": "https://xxxxxxxxx", 
             "target": [
                 {
                     "recognitionType": "safetyHelmet", 
                     "TargetInfo": {
                         "recognition": "safetyHelmet", 
                         "dataSource": "trigger"
                     }, 
                     "rect": [
                         {
                             "height": 0.237748, 
                             "width": 0.125098, 
                             "x": 0.75215, 
                             "y": 0.312826
                         }
                     ], 
                     "safetyHelmetURL": "", 
                     "pId": "123456789",
                     "Face":{
                         "FDID":"1123",
                         "FPID":"test",
                         "contentID":"faceLibPic",
                         "pId":"F4F665D6A18E41308CE9934DCDDD3333",
                         "libFacePicURL":"test"
                     },
                     "FaceList":[
                         {
                             "FDID":"1123",
                             "FPID":"test",
                             "contentID":"faceLibPic",
                             "pId":"F4F665D6A18E41308CE9934DCDDD3333",
                             "name":"test",
                             "certificateType":"passportID",
                             "certificateNumber":"test"
                         }
                     ]
                 }
             ]
         }
        

智慧城管事件

open_city_management_event消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelID通道号Integer是
dateTime事件触发时间String是
channelName通道名称String是
isDataRetransmission重传数据标记:true-重传数据,false-实时数据Boolean否
Result智慧城管检测结果List是

Result格式:

字段名描述类型是否必填
ruleID规则IDString是
rectID规则区域IDString否
subEventType子事件类型String是
Target目标信息,目前仅上报1个目标List是
backgroundImageURL背景大图URLString否
ruleName规则名称String是
triggerTime触发报警时间:0-1800秒,默认30秒;城管事件持续出现时间超过该阈值后,算法开始推送事件报警Integer否
confidence置信度,0-100,默认10;置信度越高,该事件触发报警的可信度越高Integer否
percentage占比,0-100,默认50;报警目标落在规则区域内的面积占规则区域总面积的比例来判断,当比例大于占比时,该报警目标属于该规则Integer否

subEventType类型列表:

subEventType类型
unregisteredStreetVendor非法摆摊(游摊小贩)
stallOutsideShop店外经营
stallOccupyingRoad占道经营
illegalHeap乱堆物堆料
illegalParkingofNon-MotorVehicle非机动车乱停放
illegalOutdoorAdvertisement户外广告
packGarbage打包垃圾
stallUnderUmbrella违规撑伞
dustbinOverflow垃圾箱满溢
exposeGarbage暴露垃圾
hangClothingAlongStreet沿街晾晒

Target格式:

字段名描述类型是否必填
targetID目标IDString否
Rect目标矩形框Object是
targetImageURL目标小图URLString否

rect格式

字段名描述类型是否必填
x左上角点横坐标Integer是
y左上角点纵坐标Integer是
width宽度Integer是
height高度Integer是

open_city_management_event消息示例:

         {
             "deviceSerial": "C81133734", 
             "channelID": 1, 
             "dateTime": "2020-10-15T17:30:08+08:00", 
             "channelName": "ABC", 
             "deviceID": "test0123", 
             "isDataRetransmission": "true", 
             "targetAttrs": {
                 "deviceId": "1", 
                 "deviceChannel": 1, 
                 "deviceName": "shebei"
             }, 
             "taskID": "", 
             "algorithmInfo": {
                 "algorithmId": "", 
                 "algoVendorId": "", 
                 "algoVersionId": "", 
                 "algoChipType": "", 
                 "algoModelVersion": ""
             }, 
             "Result": [
                 {
                     "ruleID": 1, 
                     "rectID": "", 
                     "subEventType": "unregisteredStreetVendor", 
                     "backgroundImageURL": "https://open.ys7.com/big.jpg", 
                     "ruleName": "name1", 
                     "triggerTime": 30, 
                     "confidence": 10, 
                     "percentage": 50, 
                     "Target": [
                         {
                             "targetID": 1, 
                             "targetImageURL": "https://open.ys7.com/small.jpg", 
                             "detectRect": {
                                 "polygon": [
                                     {
                                         "x": 0.12, 
                                         "y": 0.12
                                     }
                                 ]
                             }, 
                             "Rect": {
                                 "x": 0, 
                                 "y": 0, 
                                 "width": 1, 
                                 "height": 1
                             }
                         }
                     ], 
                     "AbsoluteHigh": {
                         "elevation": 11, 
                         "azimuth": 22, 
                         "absoluteZoom": 33
                     }, 
                     "DeviceGPS": {
                         "divisionEW": "E", 
                         "longitude": 100, 
                         "divisionNS": "N", 
                         "latitude": 100, 
                         "direction": 100, 
                         "speed": 100
                     }
                 }
             ]
         }
        

高空抛物检测事件

open_objects_thrown_detection消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelID通道号Integer是
dateTime抓拍时间String是
channelName通道名称String是
isDataRetransmission重传数据标记,true-重传数据,false-实时数据Boolean是
ObjectsThrownDetection高空抛物检测数据Object否

ObjectsThrownDetection格式:

字段名描述类型是否必填
startTime开始对抛出物体进行检测的时间String是
endTime结束对抛出物体进行检测的时间String是
RuleInfo规则信息Object否
Image高空抛物事件检测图片Object否
Video高空抛物事件检测小视频Object否

RuleInfo格式:

字段名描述类型是否必填
ruleID规则IDString是
ruleName规则名称String否
sensitive目标灵敏度,范围1-100,高灵敏度对应低漏报;低灵敏度对应低误报Integer否
confidence事件上报置信度,范围1-100,算法判定报警置信度高于配置值后;进行报警上报Integer否
uploadPicEnabled事件是否联动图片上报Boolean否
overlayPicEnabled是否对事件图片中做抛物线OSD叠加Boolean否
uploadVideoEnabled事件是否联动小视频数据上报Boolean否

Image、Video格式

字段名描述类型是否必填
resourcesContentType资源类型String否
resourcesContent当resourcesContentType为url时;该节点填写具体的urlString否

open_objects_thrown_detection消息示例:

         {
             "deviceSerial": "C13032017", 
             "channelID": 1, 
             "dateTime": "2021-03-03T10:56:59+08:00", 
             "channelName": "Camera 01", 
             "isDataRetransmission": false, 
             "ObjectsThrownDetection": [
                 {
                     "startTime": "2021-03-03T10:56:58+08:00", 
                     "endTime": "2021-03-03T10:56:59+08:00", 
                     "RuleInfo": {
                         "ruleID": "1", 
                         "ruleName": "test2", 
                         "sensitive": 74, 
                         "confidence": 60, 
                         "uploadPicEnabled": true, 
                         "overlayPicEnabled": true, 
                         "uploadVideoEnabled": true
                     }, 
                     "Image": {
                         "resourcesContentType": "url", 
                         "resourcesContent": "https://open.ys7.com/api/lapp/mq/downloadurl******"
                     }
                 }
             ]
         }
        

访客事件

open_visitor_event格式定义:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime事件时间:格式yyyy-MM-ddTHH:mm:ss+ZString是
VisitorEvent访客事件Object是

VisitorEvent格式定义:

字段名描述类型是否必填
uuid由设备生成,全局唯一标识符,访客一次登记/签离/预约唯一String是
name姓名String否
sex性别,male-男,female-女String否
certificateType证件类型(ID-身份证)String否
IDNum身份证号String否
phoneNo手机号String否
registerType登记类型(appointment-预约、noAppointment-非预约、goTogether-预约随行)String否
registerStatus人员登记状态(registered-已登记,notRegister-未登记,signOff-已签离,overdueAutoSignOff-超期自动签离,overdueNotRegister-超期未登记(预约访客预约当天没有进行登记,登记作废))String否
reason来访事由String否
receptionistName接待人员姓名String否
receptionistDepartment接待人员部门String否
plateNo车牌号String否
company访客单位String否
belongings携带物品String否
ORCodeEnabled是否生成二维码String否
currentEvent是否为实时事件,true-是(实时事件),false-否(离线事件)boolean否
VisitorImage访客图片Object否

VisitorImage格式定义:

字段名描述类型是否必传
resourcesContentType资源传输类型,当报文中带有图片时,该节点必须返回:url-url方式传输,binary-二进制方式传输String否
resourcesContent当resourcesContentType为url时,该节点填写具体的urlString否

open_visitor_event示例:

         {
            "deviceSerial": "220252990", 
            "dateTime": "2020-11-09T11:09:30+08:00", 
            "VisitorEvent": {
                "uuid": "77ef3ff15dae4777b6656f396e843edc", 
                "name": "张三", 
                "sex": "male", 
                "certificateType": "ID", 
                "phoneNo": "", 
                "registerType": "noAppointment", 
                "registerStatus": "registered", 
                "reason": "", 
                "receptionistName": "", 
                "receptionistDepartment": "", 
                "plateNo": "", 
                "company": "", 
                "belongings": "", 
                "remark": "", 
                "currentEvent": true, 
                "IDNum": "333333333333333333", 
                "ORCodeEnabled": false, 
                "VisitorImage": {
                    "resourcesContentType": "url", 
                    "resourcesContent": "https://open.ys7.com/api/lapp/mq/downloadurl?"
                }
            }
         }
        

AI任务执行结果消息

ai_message_task_result消息格式:

属性名称属性描述类型
traceId消息链路idString
taskInfo任务信息Object
captureDestination抓图目标Object
captureResult抓图结果Object
deviceRuleResult设备规则结果Object
algorithmResult算法结果Object
ruleResult消息规则Object
…定制属性Object

taskInfo:

属性名称属性描述类型
taskId任务idString
taskName任务名称String
taskType任务类型,CLOUD,IPCH7,NVRString
trainId训练版本idString

captureDestination:

属性名称属性描述类型
channelId通道idString
deviceId设备IdString
deviceSerial设备序列号String
deviceName设备名称String
channelNo通道号Integer
channelName通道名称String
groupId分组idString
groupName分组名称String

captureResult:

属性名称属性描述类型
captureTime抓图时间Long
resultUrl抓图地址String

algorithmResult:

属性名称属性描述类型
width必填,图片宽String
height必填,图片高String
modelID模型id ,对应算法描述中的modelIdString
id目标id,图片选填,视频必填int
type对应labelInfo中的typeint
confidence检测结果置信度range=[0,1000]int
name检测结果的名称,对应描述中labelInfo中的名称String
rect目标框,百分比表示,x,y为左上点坐标,w,h为宽高Object
polygon多边形目标框,百分比,左上表示(0,0),使用坐标点表示,Object
properties分类结果Object
classify分类结果详情Object
attrType分类类型,对应labelInfo中的类别idint
typeName对应类别名称string
attrValue分类属性,对应labelInfo中的属性idint
valueName分类属性的名称,对应labelInfo中的属性名称String
attrConf分类结果置信度range=[0,1000]int

deviceRuleResult:

属性名称属性描述类型
alertInfo报警信息Array
—target目标Object
—ruleInfo规则信息Object

消息示例:

         deviceRuleResult =  {
             alertInfo :[
                 {
                     target: {
                         "id": 190,
                         "type": 3,
                         "confidence": 451,
                         "region": {"rect": {"x": "0.558594", "y": "0.708333", "w": "0.111719", "h": "0.123611"}}
                     },
                     ruleInfo: {
                         "ruleID": 1,
                         "triggerType": 1073774593,
                         "movDir": 0,
                         "region": {
                             "polygon": [{"x": "0.010000", "y": "0.010000"}, {
                                 "x": "0.010000",
                                 "y": "0.990000"
                             }, {"x": "0.990000", "y": "0.990000"}, {"x": "0.990000", "y": "0.010000"}]
                         }
                     }
                 }
             ]
         }
        

ruleResult:

属性名称属性描述类型
ruleId规则idString
ruleName规则名称String

消息示例:

         {
             "traceId": "d166b9db7ebe4c86993cdef70c564277", 
             "taskInfo": {
                 "taskId": "40a0be7d50bd4e3fb09ecabe6d60b4cf", 
                 "taskName": "顾客行为分析", 
                 "taskType": "CLOUD", 
                 "trainId": "eaa438a2d4604270881d3a44f9a4f330"
             }, 
             "captureDestination": {
                 "channelId": "f24f6d5956ce40559808e87d4b91f4a7", 
                 "deviceId": "d587f1a418e841bf9a1c81364ddb76b0", 
                 "deviceSerial": "C87503883", 
                 "deviceName": "DS-2XA8A45-LZS(C87503883)", 
                 "channelNo": 1, 
                 "channelName": "DS-2XA8A45-LZS(C87503883)", 
                 "groupId": "9b8df196b93146d387ce0199c1128012", 
                 "groupName": "郝洲新光店"
             }, 
             "captureResult": {
                 "captureTime": "2019-05-31 10:02:41", 
                 "resultUrl": "https://abc.xx.xx"
             }, 
             "algorithmResult": {
                 "width": "2560", 
                 "height": "1440", 
                 "targets": [
                     {
                         "obj": {
                             "confidence": 845, 
                             "id": 0, 
                             "type": 1, 
                             "name": "人", 
                             "modelID": "a1c0908e729b4455a322609e455a6036", 
                             "rect": {
                                 "x": "0.058594", 
                                 "y": "0.376389", 
                                 "w": "0.060156", 
                                 "h": "0.108333"
                             },
                             "polygon": [{
                                     "x" : "0.058594",
                                     "y" : "0.376389"
                                 },{
                                     "x" : "0.058594",
                                     "y" : "0.376389"
                                 },{
                                     "x" : "0.058594",
                                     "y" : "0.376389"
                                 },{
                                     "x" : "0.058594",
                                     "y" : "0.376389"
                                 }]
                         }, 
                         "properties": [
                             {
                                 "modelID": "c68ba8e442bc49e48c0138646ffad68a", 
                                 "classify": {
                                     "attrConf": 999, 
                                     "attrType": 0, 
                                     "typeName": "行为", 
                                     "attrValue": 2, 
                                     "valueName": "坐着"
                                 }
                             }, 
                             {
                                 "modelID": "c68ba8e442bc49e48c0138646ffad68a", 
                                 "classify": {
                                     "attrConf": 632, 
                                     "attrType": 1, 
                                     "typeName": "是否戴眼镜", 
                                     "attrValue": 1, 
                                     "valueName": "不戴眼镜"
                                 }
                             }
                         ]
                     }
                 ]
             },
             "ruleResult": {
                 "ruleId": "bcc6c9dc06cc46199600678fb1dc78c0", 
                 "ruleName": "顾客戴眼镜报警"
             }
         }
        

人员信息采集消息

协议字段说明:

  • deviceSerial:字符串,不为空;设备序列号
  • channelNo:整数,不为空;通道号
  • dateTime:字符串,不为空;事件时间,格式为”2021-01-03T17:30:08+08:00”
  • activePostCount:整数,不为空;同一个事件上传的次数
  • userInfo:对象,不为空;用户信息
    • lastCaptureNo:整数,不为空;上一个采集序号,判断数据是否丢失
    • captureNo:整数,不为空;当前采集序号
    • dataType:字符串,可以为空;数据类型状态,值为:[new-新增的数据,modified-修改过的数据,normal-未变更]
    • riskDataMark:布尔,可以为空;取值:[true-标记数据为风险数据,人证比对失败;false-或者不返回表示数据正常]
    • name:字符串,可以为空;人员名称
    • employeeNo:字符串,不为空;人员编(工)号
    • faceUrl:字符串,可以为空;人脸图片地址
    • idcardNo:字符串,可以为空;人员身份证号
    • identityInfo:对象,可以为空;身份证信息
      • chnName:字符串,可以为空;中文名称
      • enName:字符串,可以为空;英文名称
      • gender:字符串,可以为空;性别,取值:[male-男,female-女]
      • birth:字符串,可以为空;出生日期,格式为”20121224”
      • addr:字符串,可以为空;住址
      • idcardNo:字符串,可以为空;身份证号
      • issuingAuthority:字符串,可以为空;签发机关
      • startDate:字符串,可以为空;有效期起始时间,格式为”20121224”
      • endDate:字符串,可以为空;有效期截止时间,格式为”20121224”
      • nation:整数,可以为空;民族,取值:[1-“汉”,2-“蒙古”,3-“回”,4-“藏”,5-“维吾尔”,6-“苗”,7-“彝”,8-“壮”,9-“布依”,10-“朝鲜”,11-“满”,12-“侗”,13-“瑶”,14-“白”,15-“土家”,16-“哈尼”,17-“哈萨克”,18-“傣”,19-“黎”,20-“傈僳”,21-“佤”,22-“畲”,23-“高山”,24-“拉祜”,25-“水”,26-“东乡”,27-“纳西”,28-“景颇”,29-“柯尔克孜”,30-“土”,31-“达斡尔”,32-“仫佬”,33-“羌”,34-“布朗”,35-“撒拉”,36-“毛南”,37-“仡佬”,38-“锡伯”,39-“阿昌”,40-“普米”,41-“塔吉克”,42-“怒”,43-“乌孜别克”,44-“俄罗斯”,45-“鄂温克”,46-“德昂”,47-“保安”,48-“裕固”,49-“京”,50-“塔塔尔”,51-“独龙”,52-“鄂伦春”,53-“赫哲”,54-“门巴”,55-“珞巴”,56-“基诺”,57及之后为未知]
      • passNo:字符串,可以为空;通行证号码
      • issueNumber:字符串,可以为空;签发次数
      • certificateType:字符串,可以为空;证件类型识别
      • permanentResidenceCardNo:字符串,可以为空;永久居留证号码
      • nationalityOrAreaCode:字符串,可以为空;国籍或地区代码
      • version:字符串,可以为空;证件版本号
      • receivingAuthorityCode:字符串,可以为空;受理机关代码
      • faceData:字符串,可以为空;身份证人脸照片数据,base64编码
      • fingerprints:字符串数组,可以为空;身份证指纹
    • fingerprints:对象数组,可以为空;指纹信息
      • fingerprintNo:整数,不为空;指纹编号
      • fingerprintData:字符串,不为空;指纹数据
    • cards:对象数组,可以为空;卡片信息
      • cardNo:字符串,不为空;卡号
      • cardType:字符串,不为空;卡类型,取值:[TypeA_M1, TypeA_CPU, TypeB, ID_125K, FelicaCard,DesfireCard]

人员信息采集消息:

         {
             "deviceSerial": "X34289430",
             "channelNo": 1,
             "dateTime": "2021-01-03T17:30:08+08:00",
             "activePostCount": 1,
             "userInfo": {
                 "lastCaptureNo": 0,
                 "captureNo": 1,
                 "dataType": "new",
                 "riskDataMark": false,
                 "name": "王大锤",
                 "employeeNo": "1234567",
                 "faceUrl": "https://xxxxx.jpg",
                 "idcardNo": "000000000000000000",
                 "identityInfo": {
                     "chnName": "王大锤",
                     "enName": "wangdachui",
                     "gender": "male",
                     "birth": "20121224",
                     "addr": "杭州市滨江区xxx街道0号",
                     "idcardNo": "000000000000000000",
                     "issuingAuthority": "杭州市滨江区公安局",
                     "startDate": "20201224",
                     "endDate": "20301224",
                     "nation": 1,
                     "passNo": "",
                     "issueNumber": "",
                     "certificateType": "",
                     "permanentResidenceCardNo": "",
                     "nationalityOrAreaCode": "",
                     "version": "",
                     "receivingAuthorityCode": "",
                     "faceData": "/9j/2wCEAAIBAQEBAQIBAQECAgICAgQ...",
                     "fingerprints": [
                         "QwEHEgELUQAAAAAAAAAAAAAAAB4BmniwAP///////0U1xf", 
                         "QwEHEgELUQAAAAAAAAAAAAAAAB4BmniwAP///////601C/z"
                     ]
                 },
                 "fingerprints": [{
                     "fingerprintNo": 1,
                     "fingerprintData": "QwEHEgELUQAAAAAAAAAAAAAAAB4BmniwAP///////0U1xf"
                 }],
                 "cards": [{
                     "cardNo": "101112",
                     "cardType": "TypeA_CPU"
                 }]
             }
         }
        

混合目标检测

open_mixed_target_detection 格式定义:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelID通道号Integer否
dateTime事件时间:格式yyyy-MM-ddTHH:mm:ss+ZString是
channelName通道名称String否
isDataRetransmission数据重传标识,true表示是重传的数据Boolean否
captureResultTargetNum本次报警信息上报的目标数量Integer否
CaptureResult抓拍结果Object是

CaptureResult 格式定义:

字段名描述类型是否必填
targetID抓拍目标ID,表明在一次抓拍中识别目标的唯一性String是
sid场景IDString否
sceneName场景名称String否
uid事件唯一标识String否
targetType目标类型:vehicle-机动车,human-人,nonMotor-非机动车String否
Face人脸属性Object否
Human人体属性Object否

Face 格式定义:

字段名描述类型是否必传
faceImageURL人脸小图地址String否
faceBackgroundImageURL人脸背景大图URL,当设备对该目标同时检测到人体和人脸属性的情况下,将会共用一张背景大图String否
snapTime抓拍时间String否
Rect人脸小图(特征图)矩形框,人脸特征图坐标Object否
FacePictureRect人脸矩形框,该坐标为头肩照坐标,按照这个坐标抠出来的图片,等同于设备上传的人脸小图(faceImageURL)Object否
Property人脸属性List否

Human 格式定义:

字段名描述类型是否必传
humanImageURL人体小图URLString否
humanBackgroundImageURL人体背景图URL,当设备对该目标同时检测到人体和人脸属性的情况下,将会共用一张背景大图String否
snapTime抓拍时间String否
Rect人体小图矩形框Object否
Property人体属性List否

open_mixed_target_detection 示例:

         {
             "deviceSerial": "F02042655", 
             "channelID": 1, 
             "dateTime": "2021-03-24T17:30:08+08:00", 
             "channelName": "ABC", 
             "isDataRetransmission": true, 
             "captureResultTargetNum": 10, 
             "CaptureResult": [
                 {
                     "targetID": 1, 
                     "sid": "123", 
                     "sceneName": "场景1", 
                     "uid": "", 
                     "Face": {
                         "faceImageURL": "", 
                         "faceBackgroundImageURL": "", 
                         "snapTime": "2015-06-04T19:25:16-07:00", 
                         "Rect": {
                             "x": 0, 
                             "y": 0, 
                             "width": 1, 
                             "height": 1
                         }, 
                         "Property": [
                             {
                                 "description": "age", 
                                 "value": "23"
                             }, 
                             {
                                 "description": "ageGroup", 
                                 "value": "old"
                             }, 
                             {
                                 "description": "gender", 
                                 "value": "male"
                             }, 
                             {
                                 "description": "glass", 
                                 "value": "yes"
                             }, 
                             {
                                 "description": "smile", 
                                 "value": "yes"
                             }, 
                             {
                                 "description": "mask", 
                                 "value": ""
                             }, 
                             {
                                 "description": "faceExpression", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "hat", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "score", 
                                 "value": "65"
                             }
                         ], 
                         "FacePictureRect": {
                             "x": 0, 
                             "y": 0, 
                             "width": 1, 
                             "height": 1
                         }
                     }, 
                     "Human": {
                         "modeldata": "", 
                         "humanImageURL": "", 
                         "humanBackgroundImageURL": "", 
                         "snapTime": "2015-06-04T19:25:16-07:00", 
                         "Rect": {
                             "x": 0, 
                             "y": 0, 
                             "width": 1, 
                             "height": 1
                         }, 
                         "Property": [
                             {
                                 "description": "jacketColor", 
                                 "value": "white"
                             }, 
                             {
                                 "description": "trousersColor", 
                                 "value": "white"
                             }, 
                             {
                                 "description": "glass", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "ageGroup", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "ride", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "gender", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "bag", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "things", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "hat", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "jacketType", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "trousersType", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "mask", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "hairStyle", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "cyclingPersonNumber", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "motionStatus", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "direction", 
                                 "value": "up"
                             }, 
                             {
                                 "description": "hatStyle", 
                                 "value": "unknown"
                             }, 
                             {
                                 "description": "cyclingType", 
                                 "value": "unknown"
                             }
                         ]
                     }
                 }
             ]
         }
        

停车检测

open_message_parking 消息格式:

字段名描述类型是否必填
dateTime事件时间(UTC时间)String是
deviceSerial设备序列号String是
channelID触发报警的设备通道号String否
channelName触发报警的设备通道名称String否
detectionPicturesNumber图片数量Integer否
plateNum车牌号String否
bkgUrl背景大图String否
plateUrl车牌地址String否
timeStamp触发报警的帧时间戳String否

open_message_parking 消息示例:

         {
             "deviceSerial": "123456789",
             "channelID": "1",
             "dateTime": "2020-10-22T14:07:53+08:00",
             "channelName": "Camera 01",
             "detectionPicturesNumber": "2",
             "plateNum": "蓝浙E378VQ",
             "bkgUrl": "https://open.ys7.com/xxxx",
             "plateUrl": "https://open.ys7.com/xxxx",
             "timeStamp": "2020-10-22T14:07:53+08:00"
         }
        

人数变化

open_message_people_num_change 消息格式:

字段名描述类型是否必填
dateTime事件时间(UTC时间)String是
deviceSerial设备序列号String是
channelID触发报警的设备通道号String否
channelName触发报警的设备通道名称String否
detectionPicturesNumber图片数量Integer否
bkgUrl背景大图String否
personCount人数Integer否
timeStamp触发报警的帧时间戳String否

open_message_people_num_change 消息示例:

         {
             "deviceSerial": "123456789",
             "channelID": "1",
             "dateTime": "2020-10-22T14:07:53+08:00",
             "channelName": "Camera 01",
             "detectionPicturesNumber": "1",
             "bkgUrl": "https://open.ys7.com/xxxx",
             "personCount": 1,
             "timeStamp": "2020-10-22T14:07:53+08:00"
         }
        

人员倒地

open_message_faildown 消息格式:

字段名描述类型是否必填
dateTime事件时间(UTC时间)String是
deviceSerial设备序列号String是
channelID触发报警的设备通道号String否
channelName触发报警的设备通道名称String否
detectionPicturesNumber图片数量Integer否
bkgUrl背景大图String否
timeStamp触发报警的帧时间戳String否

open_message_faildown 消息示例:

         {
             "deviceSerial": "123456789",
             "channelID": "1",
             "dateTime": "2020-10-22T14:07:53+08:00",
             "channelName": "Camera 01",
             "detectionPicturesNumber": "1",
             "bkgUrl": "https://open.ys7.com/xxxx",
             "timeStamp": "2020-10-22T14:07:53+08:00"
         }
        

人员滞留

open_message_retention 消息格式:

字段名描述类型是否必填
dateTime事件时间(UTC时间)String是
deviceSerial设备序列号String是
channelID触发报警的设备通道号String否
channelName触发报警的设备通道名称String否
detectionPicturesNumber图片数量Integer否
bkgUrl背景大图String否

open_message_retention 消息示例:

         {
             "deviceSerial": "123456789",
             "channelID": "1",
             "dateTime": "2020-10-22T14:07:53+08:00",
             "channelName": "Camera 01",
             "detectionPicturesNumber": "1",
             "bkgUrl": "https://open.ys7.com/xxxx"
         }
        

烟火检测

open_message_smoke_and_fire 消息格式:

字段名描述类型是否必填
dateTime事件时间(UTC时间)String是
deviceSerial设备序列号String是
channelID触发报警的设备通道号String否
channelName触发报警的设备通道名称String否
detectionRegionList检测区域列表Array否
detectionPicturesNumber图片数量Integer否
visibleLightURL可见光图片String否
thermalURL热成像图片String否

detectionRegionList 格式:

字段名描述类型是否必填
regionID区域IDInteger是
regionCoordinatesList区域点列表Array否
fireDetection火点检测信息Object否
smokeDetection烟雾检测信息Object否

fireDetection 格式:

字段名描述类型是否必填
fireRegion火点框Object否
highestPoint火点框内最高温度点坐标Object否
temperatureUnit温度单位:degreeCentigrade-摄氏度,degreeFahrenheit-华氏度,degreeKelvin-开尔文String否
fireMaxTemperature火点最高温度值Integer否
targetDistance目标距离Integer否
absoluteHighPTZ位置信息Object否
lookDownUpAngle设备高精度俯仰角Float否

smokeDetection 格式:

字段名描述类型是否必填
smokeRegion烟雾检测区域Object否
absoluteHighPTZ位置信息Object否
lookDownUpAngle设备高精度俯仰角Float否

open_message_smoke_and_fire 消息示例:

         {
             "deviceSerial": "E18424764",
             "channelID": "1",
             "dateTime": "2004-05-03T17:30:08+08:00",
             "channelName": "null",
             "detectionRegionList": [
                 {
                     "regionID": "1",
                     "regionCoordinatesList": [
                         {
                             "positionX": "0.123",
                             "positionY": "0"
                         }
                     ],
                     "fireDetection": {
                         "fireRegion": {
                             "x": 0,
                             "y": 0,
                             "width": 0,
                             "height": 0
                         },
                         "highestPoint": {
                             "x": 0,
                             "y": 0
                         },
                         "temperatureUnit": "degreeCentigrade",
                         "fireMaxTemperature": 300,
                         "targetDistance": 100,
                         "absoluteHigh": {
                             "elevation": 1,
                             "azimuth": 0,
                             "absoluteZoom": 0
                         },
                         "lookDownUpAngle": 180
                     },
                     "smokeDetection": {
                         "smokeRegion": {
                             "x": 0,
                             "y": 0,
                             "width": 0,
                             "height": 0
                         },
                         "absoluteHigh": {
                             "elevation": 1,
                             "azimuth": 0,
                             "absoluteZoom": 0
                         },
                         "lookDownUpAngle": 0
                     }
                 }
             ],
             "detectionPicturesNumber": "1",
             "visibleLightURL": "https://open.ys7.com/xxx",
             "thermalURL": "https://open.ys7.com/xxx"
         }
        

人员密度检测

open_person_density_detection 消息格式:

字段名描述类型是否必填
dateTime事件时间(UTC时间)String是
deviceSerial设备序列号String是
channelID触发报警的设备通道号String否
channelName触发报警的设备通道名称String否
personDensityResult人员密度检测结果Object否

personDensityResult 格式:

字段名描述类型是否必填
imageURL背景图地址String是
Target目标列表Array否

Target 格式:

字段名描述类型是否必填
recognitionType识别目标类型String是
TargetInfo目标信息Object否

TargetInfo 格式:

字段名描述类型是否必填
recognition识别事件类型String是
dataSource检测数据来源:timing-定时统计,trigger-人员密度等级(拥堵等级)变化触发上传(超过设置的等级限制),PDC-当任何一个检测区域的人数发生变化时上报报警,PQA-当区域内人数异常时则上报报警,DSA-当区域内人员停留时间异常时则上报报警String否
framesPeopleCounting_number单帧画面人数统计Integer否
densityLevel密度等级值[1,3] 在定时统计的模式下,如果统计的结果没有达到设置的等级限制,该字段不上传Integer否
personCnt密度等级中的统计人数限制,在定时统计的模式下,如果统计的结果没有达到设置的等级限制,该字段不上传Integer否
customName密度等级配置自定义信息,在定时统计的模式下,如果统计的结果没有达到设置的等级限制,该字段不上传String否
densityLevelChangeType人员密度等级变化类型[highToLow:由高到低,lowToHigh:由低到高]String否
regionName人员密度检测区域名称,与人员密度配置保持一致,若只支持单个区域配置的设备则无需返回该字段Float否
regionID设备高精度俯仰角Float否
occupancyRatio占空比,区域中人员所占像素占整个区域面积的比例,0-100,单位:%Float否
targetID目标IDString否
DSA人员停留时间报警Object否
PQA人数异常报警Object否

DSA 格式:

字段名描述类型是否必填
alarmTime该规则区域中人员等待时长报警值,范围为0~3600sInteger是
timeTriggerType等待时间报警触发类型:greater-大于,less-小于,equal-等于,unequal-不等于。该节点若不支持,设备的报警触发类型默认当大于来处理String否
Region规则区域坐标Array否

PQA 格式:

字段名描述类型是否必填
alarmCount规则区域统计人数报警值,范围为0~60个Integer是
countTriggerType等待人数报警触发类型:greater-大于,less-小于,equal-等于,unequal-不等于,range-在范围内,outOfRange-不在范围内String否
Region规则区域坐标Array否

Region 格式:

字段名描述类型是否必填
xx坐标,范围为0.000~1float是
yy坐标,范围为0.000~1float是

open_person_density_detection 消息示例:

         {
             "deviceSerial": "E00430928",
             "channelID": 1,
             "dateTime": "2021-08-04T10:20:58+08:00",
             "channelName": "测试通道",
             "personDensityResult": {
                 "imageURL": "https://open.ys7.com/xxxx",
                 "Target": [
                     {
                         "recognitionType": "human",
                         "TargetInfo": {
                             "recognition": "personDensityDetection",
                             "dataSource": "PQA",
                             "regionName": "区域1",
                             "regionID": 1,
                             "PQA": {
                                 "alarmCount": 3,
                                 "Region": [
                                     {
                                         "x": 0.264,
                                         "y": 0.172
                                     },
                                     {
                                         "x": 0.916,
                                         "y": 0.386
                                     },
                                     {
                                         "x": 0.694,
                                         "y": 0.981
                                     },
                                     {
                                         "x": 0.03,
                                         "y": 0.718
                                     }
                                 ]
                             }
                         }
                     }
                 ]
             }
        

插座用电量

open_socket_status 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
data消息内容Array是
type消息类型String是

data 格式:

字段名描述类型是否必填
data插座用电量String是
time消息上报时间String是

open_socket_status 消息示例:

         {"deviceSerial":"G07030165","data":[{"data":"082","time":"2021-09-28 14"}],"type":"ElectricData"}
        

插座开关状态

open_socket_switch_status 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
switchEnables消息内容Array是
type消息类型String是

switchEnables 格式:

字段名描述类型是否必填
enable插座开关Integer是
channel通道号Integer是
type插座消息类型Integer是

open_socket_switch_status 消息示例:

         {"deviceSerial":"G07030165","switchEnables":[{"enable":1,"channel":0,"type":14}],"type":"SWITCHENABLE"}
        

智能开关状态

open_switch_status 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
reported消息内容Array是
type消息类型String是

reported 格式:

字段名描述类型是否必填
channel通道号Integer是
status状态Integer是
         {"deviceSerial":"G07030165","reported":[{"status":1,"channel":0}],"type":"10"}
        

玩手机检测事件

open_play_cellphone 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime报警触发时间String是
channelID设备通道号Integer否
channelName通道名称String否
deviceID设备名称String否
PlayCellphone玩手机检测结果Object否

PlayCellphone 格式:

字段名描述类型是否必填
TaskInfo任务信息Object否
BackgroundImage事件触发时的背景图Object否
timeStampiso8601时间格式String否
ruleID规则序号Integer否
ruleName规则名称String否

TaskInfo 格式:

字段名描述类型是否必填
taskID任务IDString是
algorithmType算法类型,1#hightQualityVehicle(高质量车),2#hightPerformanceVehicle(高性能车),3#personStructModel(人员结构化建模),4#vehicleAndPersonStructModel(人和车结构化建模),5#videoFaceDetect(视频人脸检测),6#videoFaceDetectModel(视频人脸检测和建模),7#smart(人脸侦测(输出坐标框)Integer否
taskName任务名称String否
algorithmID算法包IDString否
monitorPointID监控点编号String否
monitorPointName监控点名称String否
streamType流类型,realtime#实时流,historyvideo#历史流,localvideo#本地流String否
ruleID规则IDString否
ruleCustomName用户自定义事件名称String是
algorithmInfo二次分析数据Object否

algorithmInfo 格式:

字段名描述类型是否必填
algorithmId算法包IdString否
algoVendorId厂商idInteger否
algoVersionId算法版本号idString否
algoChipType芯片类型String否
algoModelVersion模型版本String否

BackgroundImage 格式:

字段名描述类型是否必填
resourcesContentType资源传输类型,urlString否
resourcesContent资源标识IDInteger否
         {
           "deviceSerial": "D11111111",
           "channelID": 1,
           "dateTime": "2004-05-03T17:30:08+08:00",
           "channelName": "ABC",
           "deviceID": "test0123",
           "PlayCellphone": {
             "TaskInfo": {
               "taskID": "test",
               "algorithmType": 1,
               "taskName": "test",
               "algorithmID": "test",
               "monitorPointID": "test",
               "monitorPointName": "test",
               "streamType": "realtime",
               "ruleID": "1",
               "ruleCustomName": "ruleName",
               "algorithmInfo": {
                 "algorithmId": "test",
                 "algoVendorId": "test",
                 "algoVersionId": "test",
                 "algoChipType": "test",
                 "algoModelVersion": "test"
               }
             },
             "BackgroundImage": {
               "resourcesContentType": "url",
               "resourcesContent": "test"
             },
             "timeStamp": "2019-12-30T15:29:23+08:00",
             "ruleID": 0,
             "ruleName": "test"
           }
         }
        

离岗检测事件

open_leave_position 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dynChannelID数字通道号string否
channelID设备通道号Integer否
releatedChannelList报警关联通道列表,用于平台收到报警时展示预览或回放,多个通道号用逗号隔开string否
dateTime报警触发时间String是
channelName通道名称String否
deviceID设备名称String否
detectionPictureTransType图片传输方式,urlString否
detectionPicturesNumber接收报警中包含的图片数量Integer否
bkgUrl背景侦测图片的URLString否
urlCertificationType图片url认证方式,no#无(这个是针对武汉云存储协议),digest#摘要认证String否
pid图片IDString否
mode事件类型,leave#离岗事件,sleep#睡岗事件,leaveAndSleep#离睡岗事件,onPosition#在岗(当离岗人员回到岗位)String否
bkgUrl背景侦测图片的URLString否
TaskInfo任务信息Object否
timeStamp触发报警的帧的时间戳String否
detectionRegionList检测区域列表Array否
ruleID规则序号Integer否
ruleName规则名称String否

TaskInfo 格式:

字段名描述类型是否必填
taskID任务IDString是
algorithmType算法类型,1#hightQualityVehicle(高质量车),2#hightPerformanceVehicle(高性能车),3#personStructModel(人员结构化建模),4#vehicleAndPersonStructModel(人和车结构化建模),5#videoFaceDetect(视频人脸检测),6#videoFaceDetectModel(视频人脸检测和建模),7#smart(人脸侦测(输出坐标框)Integer是
taskName任务名称String否
algorithmID算法包IDString否
monitorPointID监控点编号String否
monitorPointName监控点名称String否
streamType流类型,realtime#实时流,historyvideo#历史流,localvideo#本地流String否
ruleID规则IDString否
ruleCustomName用户自定义事件名称String是
algorithmInfo二次分析数据Object否

algorithmInfo 格式:

字段名描述类型是否必填
algorithmId算法包IdString否
algoVendorId厂商idInteger否
algoVersionId算法版本号idString否
algoChipType芯片类型String否
algoModelVersion模型版本String否

detectionRegionList下对象DetectionRegionEntry格式:

字段名描述类型是否必填
regionID区域IDString是
sensitivityLevel灵敏度String否
regionCoordinatesList目标区域Array否
targetRect目标框Object否
ruleName规则名称String否

regionCoordinatesList下对象RegionCoordinates格式:

字段名描述类型是否必填
positionX区域点X坐标String是
positionY区域点Y坐标String是

targetRect 格式:

字段名描述类型是否必填
x目标x坐标Integer是
y目标y坐标Integer是
width目标宽Integer是
height目标高Integer是
         {
           "deviceSerial": "D11111111",
           "dynChannelID": "test",
           "channelID": 1,
           "releatedChannelList": "1,2,3",
           "dateTime": "2004-05-03T17:30:08+08:00",
           "channelName": "test",
           "deviceID": "12345",
           "detectionPictureTransType": "url",
           "detectionPicturesNumber": 1,
           "bkgUrl": "test",
           "urlCertificationType": "no",
           "pid": "test",
           "mode": "leave",
           "taskInfo": {
             "taskID": "test",
             "algorithmType": 1,
             "taskName": "test",
             "algorithmID": "test",
             "monitorPointID": "test",
             "monitorPointName": "test",
             "streamType": "realtime",
             "ruleID": "test",
             "ruleCustomName": "test",
             "algorithmInfo": {
               "algorithmId": "test",
               "algoVendorId": "test",
               "algoVersionId": "test",
               "algoChipType": "test",
               "algoModelVersion": "test"
             }
           },
           "timeStamp": "test",
           "detectionRegionList": [
             {
               "regionID": "test",
               "sensitivityLevel": "1",
               "regionCoordinatesList": [
                 {
                   "positionX": "50",
                   "positionY": "50"
                 }
               ],
               "targetRect": {
                 "x": 0,
                 "y": 0,
                 "width": 0,
                 "height": 0
               },
               "ruleName": "test"
             }
           ],
           "ruleID": 0,
           "ruleName": "test"
         }
        

区域定时人数统计事件

open_person_queue_timing_statistics 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime报警触发时间String是
channelID设备通道号Integer否
channelName通道名称String否
deviceID设备名称String否
PersonQueueTimingStatistics区域定时人数统计数据Object否

PersonQueueTimingStatistics 格式:

字段名描述类型是否必填
startTime开始统计时间String是
endTime结束统计时间String是
QueueTimeCounting区域定时人数统计Array是

QueueTimeCounting 格式:

字段名描述类型是否必填
ruleID规则IDInteger是
QueueTime区域定时人数统计区间Array是
ruleCount该规则内(包含各个时间区间)统计的实际人数值Integer是
ruleAverageQueueTime该规则内(包含各个时间区间)平均排队时长Integer否

QueueTime 格式:

字段名描述类型是否必填
minQueueTime最小排队时长,单位:秒Integer是
maxQueueTime最大排队时长,单位:秒,最大排队时长的值必须大于最小排队时长Integer否
count该区间内统计的实际人数值Integer是
averageQueueTime区域定时人数统计区间Integer否
         {
           "deviceSerial": "D11111111",
           "channelID": 1,
           "dateTime": "2004-05-03T17:30:08+08:00",
           "channelName": "ABC",
           "deviceID": "test0123",
           "PersonQueueTimingStatistics": {
             "startTime": "2004-05-03T17:30:08+08:00",
             "endTime": "2004-05-03T17:30:10+08:00",
             "QueueTimeCounting": [
               {
                 "ruleID": 1,
                 "ruleCount": 5,
                 "ruleAverageQueueTime": 3600,
                 "QueueTime": [
                   {
                     "minQueueTime": 1,
                     "maxQueueTime": 1,
                     "count": 5,
                     "averageQueueTime": 3600
                   }
                 ]
               }
             ]
           }
         }
        

区域实时人数检测事件

open_person_queue_realtime 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime报警触发时间String是
channelID设备通道号Integer否
releatedChannelList报警关联(同源)通道列表,子类型Integr类型Array否
deviceID设备名称String否
PersonQueueRealTimeData区域实时人数检测事件数据Object否

PersonQueueRealTimeData 格式:

字段名描述类型是否必填
targetID目标IDInteger是
ruleID该人员对应的规则区域IDInteger是
personState人员状态类型,enter#进入区域,leave#离开区域String是
waitTime人员排队实际等待时长,单位:秒Integer否
peopleNum此刻该区域内总人数Integer是
enterTime目标进入时间String否
         {
           "deviceSerial": "D11111111",
           "dateTime": "2018-03-13T19:42:27+08:00",
           "channelID": 1,
           "releatedChannelList": [
             1,
             2,
             3
           ],
           "deviceID": "test0123",
           "PersonQueueRealTimeData": {
             "targetID": 1,
             "ruleID": 1,
             "personState": "enter",
             "waitTime": 600,
             "peopleNum": 6,
             "enterTime": "2018-03-13T19:42:27+08:00"
           }
         }
        

区域人员停留时长检测事件

open_person_queue_time 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
dateTime报警触发时间String是
channelID设备通道号Integer否
releatedChannelList报警关联(同源)通道列表,子类型Integr类型Array否
deviceID设备名称String否
humanCapture人体属性Object否
backgroundImageURL背景图URLString否
contentID背景图String否

humanCapture 格式:

字段名描述类型是否必填
human人体属性Object是
rule规则属性Object否

human 格式:

字段名描述类型是否必填
targetID超过报警等待时间的人员目标IDInteger是
waitTime人员排队实际等待时长,单位:秒Integer是
Region该人员目标位置区域坐标Array是
humanImageURL人体子图URLString否
contentID人体子图String否

Region 格式:

字段名描述类型是否必填
xx坐标Float是
yy坐标Float否

rule 格式:

字段名描述类型是否必填
ruleID该人员对应的规则区域IDInteger是
alarmTime该规则区域中排队时长报警值Integer是
regionColor规则区域颜色,blue#蓝色,red#红色,yellow#黄色String是
Region规则区域坐标,属性同human对应RegionArray是
timeTriggerType等待时间报警触发类型,greater#大于,less#小于,equal#等于,unequal#不等于String否
         {
           "deviceSerial": "D11111111",
           "channelID": 1,
           "releatedChannelList": [
             1,
             2,
             3
           ],
           "dateTime": "2018-03-13T19:42:27+08:00",
           "deviceID": "test0123",
           "humanCapture": {
             "human": {
               "targetID": 1,
               "waitTime": 600,
               "humanImageURL": "test",
               "contentID": "human_image",
               "Region": [
                 {
                   "x": 0.12,
                   "y": 0.12
                 }
               ]
             },
             "rule": {
               "ruleID": 1,
               "alarmTime": 10,
               "regionColor": "blue",
               "timeTriggerType": "greater",
               "Region": [
                 {
                   "x": 0.12,
                   "y": 0.12
                 }
               ]
             }
           },
           "backgroundImageURL": "test",
           "contentID": "background_image"
         }
        

设备坠落事件

open_device_drop 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelId设备通道号Integer是
dateTime触发时间String是
eventType事件类型String是
deviceDrop事件检测结果Array否

deviceDrop内Location格式:

字段名描述类型是否必填
location设备本地位置信息Object否

location 格式:

字段名描述类型是否必填
longitudeType经度 ([E#东经,W#西经])String是
latitudeType纬度(S#南纬,N#北纬)String是
longitude经度Object是
latitude纬度Object是

longitude 格式:

字段名描述类型是否必填
degree度,范围[0,180]Integer是
minute分,范围[0,59]Integer是
sec秒,范围[0.000000,60.000000]String是

latitude 格式:

字段名描述类型是否必填
degree度,范围[0,180]Integer是
minute分,范围[0,59]Integer是
sec秒,范围[0.000000,60.000000]String是
         {
             "deviceSerial":"test0123",
             "channelId":1,
             "dateTime":"2004-05-03T17:30:08+08:00",
             "eventType":"deviceDrop",
             "deviceDrop":[
                 {
                     "location":{
                         "longitudeType":"E",
                         "latitudeType":"S",
                         "longitude":{
                             "degree":80,
                             "minute":13,
                             "sec":0
                         },
                         "latitude":{
                             "degree":80,
                             "minute":13,
                             "sec":0
                         }
                     }
                 }
             ]
         }
        

设备静止事件

deviceNotMoved 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelId设备通道号Integer是
dateTime触发时间String是
eventType事件类型String是
deviceNotMoved事件检测结果Array否

deviceNotMoved内Location格式:

字段名描述类型是否必填
location设备本地位置信息Object否

location 格式:

字段名描述类型是否必填
longitudeType经度 ([E#东经,W#西经])String是
latitudeType纬度(S#南纬,N#北纬)String是
longitude经度Object是
latitude纬度Object是

longitude 格式:

字段名描述类型是否必填
degree度,范围[0,180]Integer是
minute分,范围[0,59]Integer是
sec秒,范围[0.000000,60.000000]String是

latitude 格式:

字段名描述类型是否必填
degree度,范围[0,180]Integer是
minute分,范围[0,59]Integer是
sec秒,范围[0.000000,60.000000]String是
         {
             "deviceSerial":"test0123",
             "channelId":1,
             "dateTime":"2004-05-03T17:30:08+08:00",
             "eventType":"deviceDrop",
             "deviceNotMoved":[
                 {
                     "location":{
                         "longitudeType":"E",
                         "latitudeType":"S",
                         "longitude":{
                             "degree":80,
                             "minute":13,
                             "sec":0
                         },
                         "latitude":{
                             "degree":80,
                             "minute":13,
                             "sec":0
                         }
                     }
                 }
             ]
         }
        

设备状态上报事件

open_device_status 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelID设备通道号Integer是
dateTime触发时间String是
eventType事件类型String是
deviceStatus设备状态Object否

deviceStatus格式:

字段名描述类型是否必填
deviceUpTime设备已运行时间, 范围:[0,2147483647], 单位:秒,Integer否
dataPrealarm流量信息Object否
abnormalStaticStatus设备是否处于异常静止状态Boolean否
TemperatureList温度数据列表,范围:[0,100]Array否
CPUListCPU数据列表Array否
MemoryList内存数据列表Array否
recordStatusList录像状态列表Array否
lightStatusList灯光状态列表Array否
dialStatusList无线拨号状态列表Array否
wifiStatusListwifi状态列表Array否
batteryList电池状态列表Array否
scannerStatus扫码状态Array否

dataPrealarm 格式:

字段名描述类型是否必填
usedTrafficValue当月已使用流量, 范围:[0.000,1073741824.000], 单位:MB, 保留三位小数Float是

TemperatureList内Object 格式:

字段名描述类型是否必填
tempSensorDescription温度描述String是
temperature温度值,范围:[0,1000], 单位:℃, 保留三位小数Float是

CPUList内Object 格式:

字段名描述类型是否必填
cpuDescriptionCPU描述String是
cpuUtilizationCPU使用率,范围[0,100]Integer是

MemoryList内Object 格式:

字段名描述类型是否必填
memoryDescription内存描述String是
memoryUsage已用内存大小, 范围:[0.0,1048576.0], 单位:MB,保留一位小数Float是
memoryAvailable可用内存大小, 范围:[0.0,1048576.0], 单位:MB,保留一位小数Float是

recordStatusList内Object 格式:

字段名描述类型是否必填
channelID视频通道号Integer是
recordStatus录像状态, notRecorded表示未录像,recording表示录像中String是
recordremainingDuration录制剩余时长, 范围:[0,10000], 单位:minInteger否

lightStatusList内Object 格式:

字段名描述类型是否必填
lightType灯光类型, supplementLight表示补光灯,laserLight表示激光灯String是
lightStatus拨号状态, open表示开启,close表示关闭String是

dialStatusList内Object 格式:

字段名描述类型是否必填
networkStatus网络状态[2G#2G,3G#3G,4G#4G,Unknown#未知,5G#5G]String是
dialStatus拨号状态,[notDial#无拨号,dialing#拨号中,finishDial#拨号完成]String是
dialSignalStrength信号强度, 范围:[1,5]Integer是

wifiStatusList内Object 格式:

字段名描述类型是否必填
ssidssid信息String是
wifiState网络状态[disabled#未启用Wi-Fi,enable#启用Wi-Fi,disconnected#Wi-Fi断开,enableHotspot#启用Wi-Fi热点,fail#wifi连接失败,success#wifi连接成功,connecting#wifi连接中,nomodule#无wifi模块String是
dialSignalStrength信号强度, 范围:[1,5]Integer是

batteryList内Object 格式:

字段名描述类型是否必填
id电池idInteger是
state网络状态[discharging#未充电(放电中),charing#充电中,idle#空闲,abnormal#异常]String是
remainingBattery剩余电量, 范围:[0,10000], 单位:mA,Integer是
remainingDuration电量剩余使用时长, 范围:[0,10000], 单位:minInteger是

scannerStatus内Object 格式:

字段名描述类型是否必填
scannerFrequency扫码频次, 范围:[0,10000], 单位:次/小时Integer是
         {
             "deviceSerial":"test0123",
             "channelId":1,
             "dateTime":"2004-05-03T17:30:08+08:00",
             "eventType":"deviceStatus",
             "DeviceStatus":{
                 "deviceUpTime":1200,
                 "TemperatureList":[
                     {
                         "tempSensorDescription":"test",
                         "temperature":1
                     }
                 ],
                 "CPUList":[
                     {
                         "cpuDescription":"test",
                         "cpuUtilization":1
                     }
                 ],
                 "MemoryList":[
                     {
                         "memoryDescription":"test",
                         "memoryUsage":100,
                         "memoryAvailable":100
                     }
                 ],
                 "recordStatusList":[
                     {
                         "channelID":1,
                         "recordStatus":"recording",
                         "recordremainingDuration":5
                     }
                 ],
                 "lightStatusList":[
                     {
                         "lightType":"supplementLight",
                         "lightStatus":"open"
                     }
                 ],
                 "dialStatusList":[
                     {
                         "networkStatus":"4G",
                         "dialStatus":"notDial",
                         "dialSignalStrength":5
                     }
                 ],
                 "wifiStatusList":[
                     {
                         "ssid":"1234",
                         "wifiState":"success",
                         "dialSignalStrength":5
                     }
                 ],
                 "batteryList":[
                     {
                         "id":1,
                         "state":"discharging",
                         "remainingBattery":5,
                         "remainingDuration":5
                     }
                 ],
                 "scannerStatus":[
                     {
                         "scannerFrequency":5
                     }
                 ],
                 "dataPrealarm":{
                     "usedTrafficValue":26
                 },
                 "abnormalStaticStatus":true
             }
         }
        

按键触发抓图事件

open_local_button_snapshot 消息格式:

字段名描述类型是否必填
deviceSerial设备序列号String是
channelID设备通道号Integer是
dateTime触发时间String是
eventType事件类型String是
LocalButtonSnapshot设备本地按键触发抓图信息上报Object否

LocalButtonSnapshot:

字段名描述类型是否必填
ButtonSnapshot设备本地按键手动触发抓取的图片Object否

ButtonSnapshot 格式:

字段名描述类型是否必填
resourcesContentType资源传输类型[url#url方式传输], desc:当设备返回的报警报文中带有额外资源(比如图片)时,该节点必须返回,url-url方式传输String是
resourcesContent资源标识ID, 范围:[1,1024], 当设备返回的报警报文中带有额外资源(比如图片)时,该节点必须返回;当resourcesContentType为url时,该节点填写具体的ur)String是
         {
             "deviceSerial":"test0123",
             "channelId":1,
             "dateTime":"2004-05-03T17:30:08+08:00",
             "eventType":"localButtonSnapshot",
             "LocalButtonSnapshot":{
                 "ButtonSnapshot":{
                     "resourcesContentType":"url",
                     "resourcesContent":"http://10.13.50.100:6120/pic?=d63i0872ed611i89-5p3009--26b43e17f9eafi5b2*=2d9i0s1*=idp1*=*d176t=a-9m55b3d25b4"
                 }
             }
         }
        

AI视频任务检测事件

消息协议字段说明:

字段名描述类型是否必填
dateTime事件时间String是
deviceSerial设备序列号String是
channelId设备通道号String是
aiopData由算法库直接输出;具体的结构体参考算法库提供Object否

AI视频任务检测消息协议:

         {
             "channelID": 1,
             "dateTime": "2009-11-14T15:27:12+08:00",
             "deviceSerial": 1,
             "aiopData": {}
         }
        

【海康云眸】API开发者 微信交流群

用微信扫右侧二维码,加入【海康云眸】API开发者 交流群,互助沟通

扫码加入交流群
上一页
对接指南
下一页
创建消费者
Built with