海康云眸·连锁 API
  1. 消息类型定义
海康云眸·连锁 API
  • 产品介绍
  • 能力概览
  • 错误码表
  • 常见问题
  • 快速入门
    • 生成授权凭证
    • 接口调用说明
    • 生成access_token
      POST
  • 开发指南
    • 接口说明
    • 消息通道
  • 视频服务能力
    • 视频设备配置指南
    • 视频对接指南
    • 直播服务
    • 微信小程序接入视频服务
    • 视频集成方案
      • web视频控件
      • UIKIT
      • 标准流预览
      • 移动端SDK
        • Android
        • 错误码对照表
        • iOS
    • 直播服务
      • 开通直播间
      • 通过通道ID获取直播间地址
      • 关闭设备加密
    • 微信小程序接入视频服务
      • 1.开发指南
      • 2.小程序开发
      • 3.接口说明
        • 获取直播/回放RTMP地址
    • 取流认证
      GET
  • 设备数据
    • 修改通道名称
      POST
    • 通过门店ID查询设备通道列表
      GET
    • 通过门店编号查询设备通道列表
      GET
    • 查询所有设备通道列表
      GET
    • 通过设备序列号查询通道列表
      GET
    • 通过设备序列号查询设备录像存储记录
      GET
  • 设备能力
    • 云台控制
      • 开始云台控制
      • 停止云台控制
      • 根据通道Id查询预置点列表
      • 新增预置点
      • 调用预置点
      • 删除预置点
    • 设备抓图
      • 设备抓图
    • 修改报警能力开关
      • 修改报警能力开关
    • IO管理
      • 获取设备IO端口状态
      • 获取设备指定输出口信息
      • 配置设备指定输出口信息
      • IO输出
    • 探测器
      • 查询网关下探测器列表
      • 网关关联子设备
      • 网关解绑子设备
      • 修改子设备名称
      • 设置传感器状态
    • 云存储
      • 开通云存储
  • 门店数据
    • 获取门店列表
    • 门店布撤防状态查询
  • 客流统计
    • 通过门店ID查询客流数据
    • 通过门店编号查询客流数据
    • 查询客流数据
  • 区域热度
    • 查询区域热度配置
    • 查询驻足人次分布
    • 生成热度图
    • 获取热度图
    • 获取区域关注度配置
    • 区域关注度配置
  • POS单
    • POS单信息录入
  • 巡查服务
    • 查询自动抓图的图片数据
  • 开门事件
    • 开门事件
  • 消息通道
    • 创建消费者
    • 消费消息
    • 接口定义
    • 提交偏移量
  • 消息类型定义
    • 设备报警消息
  • 智能分析AI能力
    • 查询模型列表
    • 查询算法模型的训练版本
    • 获取算法训练版本详情
    • 图片回传
  • 身份认证
    POST
  • 获取门店区域组织节点全量列表
    GET
  1. 消息类型定义

设备报警消息

设备报警消息#

chain_device_alarm格式:
字段名描述类型是否必填
alarmTime告警时间Long是
channel通道号String是
channelType通道类型String是
customInfo扩展信息(例如萤石探测器关联网关信息)String否
devSerial设备序列号String是
alarmId告警idString是
alarmType告警类型String是
channelName通道名称String是
pictureUrl告警图片Array是
消息示例:
{
“alarmTime”: “1554822825000”,
“channel”: 1,
“channelType”: 1,
“customInfo”: “”,
“devSerial”: “123456789”,
“alarmType”: “10600”,
“alarmId”: “8da535a*****1e9-800b-d23208dad526”,
“channelName”: “收银台”,
“pictureLUrl”: “https://xx.xx.xx.jpg“
}
当报警类型为TemHumiDetection 10831 (温湿度超限报警时),customInfo字段格式为:
{
“recognition”: “temHumiDetection”,
“byTempOverlimitType”: 1, //温度超阀类型 0-没有超阀 1-超上阀 2-超下阀
“byHumiOverlimitType”: 0, //湿度超阀类型 0-没有超阀 1-超上阀 2-超下阀
“currTemperature”: 550, //温度值
“currHumidity”: 277, //湿度值
“temImageURL”: “”
}
当报警类型为TMA 10835 (体温超限报警时),customInfo字段格式为:
         {
            "detectionRegionEntry": [{
                    "regionID":"1",
                 "tma": {
                     "ruleTemperature":"30.0",    //设定的温度
                     "currTemperature":"37.6"    //当前的温度
                 }
                  "regionCoordinatesList": {
                      "rgionCoordinates":[{
                         "positionX":975,
                         "positionY":17
                     }]
                 }
             }]
         }
        
报警类型对照表
报警类型报警code码报警名称
ONLINE10065设备上线报警
OFFLINE10066设备下线报警
pir10000人体感应事件
callhelp10825紧急遥控按钮事件
motiondetect10800移动侦测报警
babycry10003婴儿啼哭
magnetometer10824门磁报警
fire10005烟感报警
gas10006可燃气体报警
waterlogging10008水浸报警
emergency10009紧急按钮报警
infrared10010人体感应报警
shelteralarm10802视频遮挡报警
videoloss10012视频丢失
linedetection10013越界侦测
fielddetection10014区域入侵
facedetection10015人脸检测事件
doorbell10016智能门铃报警
curtain10018幕帘报警
move_magnetometer10019单体门磁报警
scenechangedetection10020场景变更侦测
defocus10021虚焦侦测
audioexception10022音频异常侦测
leftdetection10023物品遗留侦测
takedetection10024物品遗留侦测
parkingdetection10025非法停车侦测
highdensitydetection10026人员聚集侦测
loiterdetection10027徘徊检测侦测
rundetection10028快速移动侦测
enterareadetection10029进入区域侦测
exitareadetection10030离开区域侦测
mag_gim10031磁干扰报警
UnderVoltage10032电池电量低报警
intrusion10033闯入报警
baby_motion10035婴儿大动作报警
PowerChange10036电源切换报警
hightemperature10037温度过高报警
lowtemperature10038温度过低报警
highhumidity10039湿度过高报警
lowhumidity10040湿度过低报警
io10100IO报警
io-110101IO-1报警
io-210102IO-2报警
io-310103IO-3报警
io-410104IO-4报警
io-510105IO-5报警
io-610106IO-6报警
io-710107IO-7报警
io-810108IO-8报警
io-910109IO-9报警
io-1010110IO-10报警
io-1110111IO-11报警
io-1210112IO-12报警
io-1310113IO-13报警
io-1410114IO-14报警
io-1510115IO-15报警
io-1610116IO-16报警
VMD12000移动侦测报警开始
tamperdetection12002遮挡报警开始
alarmTrig12003即时防区报警
alarmRest12004即时防区恢复
audio24Trig1200524小时有声防区报警
audio24Rest1200624小时有声防区恢复
enterexitTrig12007延时防区报警
enterexitRest12008延时防区恢复
internalTrig12009内部延时防区报警
internalRest12010内部延时防区恢复
fireTrig12011火警报警
fireRest12012火警防区恢复
perimeterTrig12013周界防区报警
perimeterRest12014周界防区恢复
silent24Trig1201524小时无声防区报警
silent24Rest1201624小时无声防区恢复
aux24Trig1201724小时辅助防区报警
aux24Rest1201824小时辅助防区报警恢复
vib24Trig1201924小时震动防区报警
vib24Rest1202024小时震动防区报警恢复
sensorDemol12021防区感应器被拆
sensorRecov12022防区感应器被拆恢复
softEmergTrig12023软防区紧急报警
softFireTrig12024软防区火警
softBanditTrig12025软防区匪警
hostageReport12026挟持报告
devTampering12027设备防拆
devTamperRecov12028设备防拆恢复
ACDown12029交流电掉电
ACRecov12030交流电恢复
lowBatVol12031蓄电池电压低
norBatVol12032蓄电池电压正常
telDiscon12033电话线断开
telRecov12034电话线连接
XBUSDiscon12035扩展总线模块掉线
XBUSRecov12036扩展总线模块掉线恢复
keyboardDisconn12037键盘掉线
keyboardRecov12038键盘恢复
KBUSTrigDiscon12039键盘总线上触发器掉线
KBUSTrigRecov12040键盘总线上触发器恢复
autoArmFail12041自动布撤防失败
autoDisarmFail12042自动撤防失败
wirelessExcep12043无线网络异常
wirelessRecov12044无线网络恢复正常
SIMExcep12045SIM卡异常
SIMRecov12046SIM卡恢复正常
hostReset12047主机复位
disarm12048撤防
arm12049布防
autoDisarm12050自动撤防
autoArm12051自动布防
clear12052消警
instantArm12053即时布防
keyDisarm12054钥匙防区撤防
keyArm12055钥匙防区布防
stayArm12056留守布防
forcedArm12057强制布防
bypass12058旁路
bypassRecov12059旁路恢复
grpBypass12060子系统组旁路
grpBypassRecov12061子系统组旁路恢复
manualRep12062手动测试报告
timingRep12063定时测试报告
singleDisarm12064单防区撤防
singleArm12065单防区布防
keypadLock12066键盘锁定
keypadUnlock12067键盘解锁
printerOff12068打印机掉线
printerOn12069打印机恢复
instantDisarm12070即时撤防
stayDisarm12071留守撤防
triggerScheOn12072定时开启触发器
triggerScheOff12073定时关闭触发器
acTrigFail12074定时开启触发器失败
deacTrigFail12075定时关闭触发器失败
enterProgram12076进入编程
exitProgram12077退出编程
GPKDiscon12078键盘总线上GP/K掉线
GPKRecov12079键盘总线上GP/K恢复
MNKDiscon12080键盘总线上MN/K掉线
MNKRecov12081键盘总线上MN/K恢复
IPConflict12082IP冲突
IPRecov12083IP正常
netDiscon12084网线断
netRecov12085网线正常
VMDRecov12086移动侦测报警结束
tamperRecov12087遮挡报警结束
videoRecov12088视频信号恢复
viIOUnmatch12089输入/输出视频制式不匹配
viIORecov12090输入/输出视频制式恢复正常
viInputExc12091视频输入异常
viInputRecov12092视频输入恢复正常
HDDfull12093硬盘满
HDDfree12094硬盘空闲
HDDexception12095硬盘出错
HDDRecov12096硬盘恢复正常
uploadPicFail12097图片上传失败
DetOffline12098探测器离线
DetOnline12099探测器恢复在线
DetLowBattery12100探测器电量欠压
DetBatteryRecov12101探测器电量恢复正常
zoneAddDet12102防区添加探测器
zoneDeleteDet12103防区删除探测器
wifiException12104WIFI通信异常
wifiRecov12105WIFI通信恢复正常
rfException12106RF信号异常
rfRecov12107RF信号恢复正常
MINOR_HOST_DESMANTLE_ALARM12108主机防拆报警
MINOR_HOST_DESMANTLE_RESUME12109主机防拆恢复
MINOR_CARD_READER_DESMANTLE_ALARM12110读卡器防拆报警
MINOR_CARD_READER_DESMANTLE_RESUME12111读卡器防拆恢复
MINOR_CASE_SENSOR_ALARM12112事件输入报警
MINOR_CASE_SENSOR_RESUME12113事件输入恢复
MINOR_SECURITY_MODULE_DESMANTLE_ALARM12114门控安全模块防拆报警
MINOR_SECURITY_MODULE_DESMANTLE_RESUME12115门控安全模块防拆恢复
MINOR_NET_BROKEN12116网络断开
MINOR_NET_RESUME12117网络恢复
MINOR_DEV_POWER_ON12118设备上电启动
MINOR_DEV_POWER_OFF12119设备掉电关闭
MINOR_DOOR_OPEN_ABNORMAL12120门异常打开(门磁)
emergHelp13001紧急呼叫求助报警
emergHelpRecov13002紧急呼叫求助恢复
consulting13003业务咨询开始
consulted13004业务咨询结束
overAlarm13005超时报警
overAlarmRecov13006超时报警恢复
singleCancelArm13007单防区消警
BUSQuery13008总线搜索
BUSOpen13009总线开路报警
BUSOpenRecov13010总线开路报警恢复
BUSShort13011总线短路报警
BUSShortRecov13012总线短路报警恢复
exModuleExcep13013扩展模块异常
exModuleRecov13014扩展模块恢复
exModuleLowVol13015扩展模块电压低
exModuleVolRecov13016扩展模块电压正常
exModuleTamp13017扩展模块防拆触发
exModuleTampRecov13018扩展模块防拆恢复
exModuleAcDown13019扩展模块交流电掉电
exModuleAcOn13020扩展模块交流电恢复
repeaterTamp13021无线中继器防拆触发
repeaterTampRecov13022无线中继器防拆恢复
zoneOpenAlarm13023防区开路提醒
zoneShortAlarm13024防区短路提醒
telConTest13025电话链路测试
exModuleDiscon13026扩展模块掉线
exModuleCon13027扩展模块掉线恢复
wlModuleDiscon13028无线扩展模块掉线
wlModuleCon13029无线扩展模块掉线恢复
repeaterDiscon13030无线中继器掉线
repeaterCon13031无线中继器掉线恢复
netExceed13032流量超额
delExModule13033删除扩展模块
addExModule13034添加扩展模块
delRepeater13035删除无线中继器
addRepeater13036添加无线中继器
BUSRegistration13037总线注册
DoorLock-UnClosed13038门锁虚掩报警
DoorLock-TmpPwdOpenDoor13039临时密码开门报警
audiomsg13040语音留言消息
videomsg13041视频留言消息
thermalimagingfire13042热成像火点报警
whitelistface13043陌生人报警
DoorLock-FingerprintOpenDoor13044指纹开门
DoorLock-PasswordOpenDoor13045密码开门
DoorLock-SwipeOpenDoor13046刷卡开门
DoorLock-CenterRemoteOpenDoor13047中心远程开门
DoorLock-AppRemoteOpenDoor13048APP远程开门
DoorLock-KeyOpenDoor13049钥匙开门
DoorLock-RemoteDeviceOpenDoor13050遥控器开门
DoorLock-FingerprintInfoChange13051指纹信息改动
DoorLock-PasswordInfoChange13052密码信息改动
DoorLock-UserInfoChange13053用户信息改动
DoorLock-SystemInfoChange13054系统信息改动
DoorLock-AntiHijackingFingerprint13055防劫持指纹报警
DoorLock-AntiHijackingPassword13056防劫持密码报警
DoorLock-PryDoor13057撬门报警
DoorLock-Locked13058门锁锁定报警
DoorLock-BatteryLow13059电量不足报警
DoorLock-Blacklist13060黑名单报警
DoorLock-Offline13061掉线报警
callmsg13062呼叫消息
hangupmsg13063挂断消息
DoorLock-DoorOpenAlarm13064智能锁开门提醒
DoorLock-ConfigChangeAlarm13065智能锁配置改动提醒
DoorLock-DoorbellAlarm13066门铃提醒
DoorLock-Reset13067智能锁复位
DoorLock-DataClear13068智能锁数据清空
opendoormsg13069开门消息
nothomemsg13070未回家消息
lowbattery13071电量不足报警
abnormalopendoor13072异常开门报警
unclosed13073门未关报警
hijack13074挟持报警
pry13075撬开报警
offline10066设备下线
ThirdCaption40001第三方抓图
Linkage40002互联互通
other10899其他报警
reddetect10820红外探测报警
doublecheck10821双鉴探测报警
shock10822震动探测报警
glassbreak10823玻破探测报警
infraredradiation10826红外对射探测报警
personQueueCounting10828区域人数超限报警
lowtemperaturepre10829温度过低预警
hightemperaturepre10830温度过高预警
TemHumiDetection10831温湿度超限报警
TMA10835体温超限报警
intelligentDetection10837智能检测告警
SmartHumanDet10838智能人形检测
safetyHelmetDetection10892安全帽报警
OffDuty10857人员在离岗报警
noCertificate10858无证上岗报警
batteryCarDisobey10859电瓶车乱停乱放报警
annihilatorMiss10860灭火器遗失报警
channelOccupy10861通道占用报警
smokeAlarm10862抽烟报警

AI任务执行结果消息#

ai_message_task_result消息格式:
属性名称属性描述类型
traceId消息链路idString
taskInfo任务信息Object
captureDestination抓图目标Object
captureResult抓图结果Object
algorithmResult算法结果Object
ruleResult消息规则Object
…定制属性Object
taskInfo:
属性名称属性描述类型
taskId任务idString
taskName任务名称String
taskType任务类型,CLOUD,IPCH7,NVRString
trainId训练版本idString
captureDestination:
属性名称属性描述类型
channelId通道idString
deviceId设备IdString
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
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"
                             }
                         },
                         "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":"顾客戴眼镜报警"
             }
         }
        

门禁事件报警消息#

access_event_alarm_message 消息格式:
属性名称属性描述类型是否为空
deviceSerial设备序列号字符串不为空
deviceName设备名称字符串不为空
channelNo设备通道号整型不为空
deviceBelongsNode设备所属组织,中性描述,连锁业务则表示门店ID字符串不为空
personName人员名称字符串不为空(人员不存在时为空)
staffId员工ID字符串可空
phoneNumber手机号字符串不为空(人员不存在时为空)
pictureURL事件图片URL(人脸抓拍图)字符串不为空
eventCode事件码,参考设备事件码定义整型不为空
eventTime事件发生时间(格式:2020-04-13T10:41:51+08:00)字符串不为空
currTemperature体温浮点类型可空
thermometryUnit体温单位字符串可空
消息示例:
         {
             "deviceSerial":"D67065503",
             "deviceName":"D67065503",
             "channelNo":2,
             "deviceBelongsNode":"b5175f621cf34970bc6c0760a3f0f53e",
             "personName":"zhang1V4",
             "staffId":"234",
             "phoneNumber":"17775302104",
             "departmentName":"hyj20190619",
             "pictureURL":"https://open.ys7.com/api/lapp/mq/downloadurl?appKey=省略&fileKey=省略",
             "eventCode":75,
             "eventTime":"2020-04-13T10:41:51+08:00"
         }
        
事件码定义
事件码含义
75人脸比对通过

人脸测温事件消息#

access_face_temperature_message 消息格式:
属性名称属性描述类型是否为空
deviceSerial设备序列号字符串不为空
deviceName设备名称字符串不为空
serialNo事件流水号整型不为空
deviceBelongsNode设备所属组织,中性描述,连锁业务则表示门店ID字符串不为空
currentEvent是否为实时事件,true-实时,false-非实时布尔型可空
thermometryUnit测温单位(celsius-摄氏度(默认),fahrenheit-华氏度,kelvin-开尔文)字符串不为空
currTemperature人脸温度(精确到小数点后一位)浮点型不为空
isAbnomalTemperature人脸测温是否温度异常(true-是,false-否)布尔型不为空
mask是否戴口罩:unknown-未知,yes-戴口罩,no-不戴口罩字符串可空
eventTime事件发生时间(格式:2020-04-13T10:41:51+08:00)字符串不为空
thermalURL热成像图片URL字符串可空
visibleLightURL热成像相机可见光图片URL字符串可空
pictureURL抓拍图片URL字符串可空
消息示例:
         {
             "deviceSerial":"D67065503",
             "deviceName":"D67065503",
             "serialNo":3344,
             "deviceBelongsNode":"b5175f621cf34970bc6c0760a3f0f53e",
             "currentEvent":true,
             "thermometryUnit":"celsius",
             "currTemperature":"36.4",
             "isAbnomalTemperature":false,
             "mask":"yes",
             "eventTime":"2021-04-13T14:41:51+08:00",
             "thermalURL":"https://open.ys7.com/api/lapp/mq/downloadurl?appKey=省略&fileKey=省略"
         }
        

身份证事件消息#

access_id_card_info_message 消息格式:
属性名称属性描述类型是否为空
deviceSerial设备序列号String不为空
deviceName设备名String不为空
serialNo事件流水号Integer不为空
deviceBelongsNode设备所属组织,中性描述,连锁业务则表示门店IDString不为空
currentEvent是否为实时事件,true-实时,false-非实时Boolean可空
thermometryUnit测温单位(celsius-摄氏度(默认),fahrenheit-华氏度,kelvin-开尔文)String可空
currTemperature人脸温度(精确到小数点后一位)Float可空
isAbnomalTemperature人脸测温是否温度异常(true-是,false-否)Boolean可空
mask是否戴口罩:unknown-未知,yes-戴口罩,no-不戴口罩String可空
visibleLightURL热成像相机可见光图片URLString可空
thermalURL热成像图片URLString可空
pictureURL人脸抓拍图片URLString不为空
idCardPicURL身份证人脸图片String不为空
tenantId租户idString不为空
eventTime事件发生时间(格式:2020-04-13T10:41:51+08:00)String不为空
idCardInfo身份证信息Object不为空
身份证信息idCardInfo字段
属性名称属性描述类型是否为空
name姓名String不为空
sex性别(male-男,female-女)String不为空
birth生日(例如:1996-01-02)String不为空
addr住址String不为空
idCardNo身份证号String不为空
issuingAuthority签发机关String不为空
startDate有效期-起始时间(例如:2019-01-01)String不为空
endDate有效期-截至时间(例如:2024-01-01)String不为空
nation民族(例如:汉)String不为空
isLongTermEffective是否长期有效Boolean不为空
消息示例:
         {
             "deviceSerial":"D67065503",
             "deviceName":"身份证设备",
             "serialNo":2,
             "deviceBelongsNode":"b5175f621cf34970bc6c0760a3f0f53e",
             "currentEvent":true,
             "thermometryUnit":null,
             "currTemperature":null,
             "isAbnomalTemperature":null,
             "mask":null,
             "eventTime":"2021-05-25T15:24:04+08:00",
             "visibleLightURL":null,
             "thermalURL":null,
             "pictureURL":"https://open.ys7.com/api/lapp/mq/downloadurl?appKey=XXXXXX&fileKey=XXXXX",
             "idCardPicURL":"https://open.ys7.com/api/lapp/mq/downloadurl?appKey=XXXXXXXXX&fileKey=XXXXXXXXX",
             "tenantId":"5430f4d6482640e8855461f43e93e7f2",
             "idCardInfo":{
                 "name":"张三",
                 "sex":"male",
                 "birth":"1996-01-24",
                 "addr":"浙江省杭州市滨江区阡陌路555号",
                 "idCardNo":"310330199601245678",
                 "issuingAuthority":"杭州市公安局",
                 "startDate":"2014-08-10",
                 "endDate":"2024-08-10",
                 "nation":"汉",
                 "isLongTermEffective":false
             }
         }
        

车牌识别消息#

chain_plateNumber格式:
字段名描述类型是否必填
tenantId租户IDString是
storeId门店IDString是
storeName门店名称String是
storeNo门店编号String否
dateTime时间dateTime是
messageId告警idString是
serialNumber设备序列号String是
serialName设备String是
channelNumber通道编号String是
channelName通道名称String是
carNumber车牌号String是
captureTime抓拍时间long是
dateLong系统时间long是
消息示例:
         {
             "tenantId":"6fc824ba6c2249fa8b3c6c691bca9dd5",
             "storeId":"2d901fc9c74340099b877aee0868c8b4",
             "storeName":"41O7-七都(新)",
             "storeNo":"41O7",
             "dateTime":1625841480000,
             "messageId":"YnCpDki8j7kn353hKtvi85uq0PPTWH18y",
             "serialNumber":"E82957504",
             "serialName":"前台(2)",
             "channelNumber":"7",
             "channelName":"通道名称",
             "carNumber":"鲁LK33D9",
             "captureTime":1625841480000,
             "dateLong":1625813728813
         }
        

热度实时上报数据消息#

chain_heat_realTime 消息格式:
字段名描述类型是否必填
deviceSerial设备序列号String是
ipAddress报警设备IPv4地址String是
portNo报警设备端口号String否
protocol协议类型String否
macAddressMAC地址String否
channelID触发报警的设备通道号Integer否
dateTime报警触发时间(格式:2018-03-13T19:42:27+08:00)String是
activePostCount同一个报警已经上传的次数Integer是
eventType触发的事件类型String是
eventState事件触发状态(active-触发,inactive-未触发)String是
eventDescription事件描述String是
isDataRetransmission重传数据标记。由于网络异常等因素,导致的实时检测的数据上传失败,后设备异常因素恢复后“重新”上传当时的采集分析数据(true-是,false-否)Boolean否
PersonQueueRealTimeData人员排队检测实时数据信息Object是
人员排队检测实时数据信息PersonQueueRealTimeData 字段:
字段名描述类型是否必填
targetID目标IDInteger是
ruleID该人员对应的规则区域IDInteger是
personState人员状态类型(enter-进入区域,leave-离开区域)String是
waitTime人员排队实际等待时长(range:[0,3600] unit:s)(当personState为leave时才返回)Integer否
peopleNum此刻该区域内总人数Integer是
enterTime目标进入时间 (当personState为leave时才返回)String否
消息示例:
进入报文
             {
                 "deviceSerial":"J22542130",
                 "ipAddress":"10.10.60.123",
                 "portNo":443,
                 "protocol":"HTTPS",
                 "macAddress":"24:0f:0b:78:23:bc",
                 "channelID":1,
                 "dateTime":"2021-12-27T18:42:39+08:00",
                 "activePostCount":1,
                 "eventType":"personQueueRealTime",
                 "eventState":"active",
                 "eventDescription":"Person Queue Real Time Data",
                 "isDataRetransmission":false,
                 "PersonQueueRealTimeData":{
                     "targetID":331,
                     "ruleID":3,
                     "personState":"enter",
                     "peopleNum":2
                 }
             }
        
离开报文
             {
                 "deviceSerial":"J22542130",
                 "ipAddress":"10.10.60.123",
                 "portNo":443,
                 "protocol":"HTTPS",
                 "macAddress":"24:1f:0b:78:23:bc",
                 "channelID":1,
                 "dateTime":"2021-12-27T18:42:39+08:00",
                 "activePostCount":1,
                 "eventType":"personQueueRealTime",
                 "eventState":"active",
                 "eventDescription":"Person Queue Real Time Data",
                 "isDataRetransmission":false,
                 "PersonQueueRealTimeData":{
                     "targetID":331,
                     "ruleID":3,
                     "personState":"leave",
                     "waitTime":1,
                     "peopleNum":1,
                     "enterTime":"2021-12-27T18:42:38+08:00"
                 }
             }

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

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

扫码加入交流群
上一页
提交偏移量
下一页
查询模型列表
Built with