事件消息格式定义
事件消息格式定义
设备普通报警消息格式如下
{
"id": 2447736561, //[Long][Not Null]报警消息id,对应“查询用户报警信息”接口返回的alarmId
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"did": "TESTQWERXXXX", //[String][Not Null]设备序列号
"cid": 0, //[Integer][Not Null]设备通道号
"msgType": "videoMotion", //[String][Not Null]设备报警类型
"time": 1475052555, //[long][Not Null]报警时间
"cname": "TESTQWERXXXX", //[String][Not Null]通道名称
"remark": "", //[String][Nullable]备注
"token": "f2dc8c09eeae4b5bad6abf522c93d825", //[String][Nullable]云录像token,
"desc": {
//[Null]可选,备注信息
}
}
备注:
1、只有 platForm 为 4 的设备触发报警消息才会带上“token”字段
2、desc 字段在不同的消息类型中,存放不同的字段
msgType=beOpenedDoor 开启门锁时
"desc": {
//[String]开锁秘钥名称
"name": "管理员指纹",
//[String]秘钥唯一id
"keyId": "0",
//[String]开锁秘钥类型
"type": "fingerPrint"
}
乐橙开放平台推送的设备上下线消息格式如下
根据设备类型不同,上下线消息分为两种格式。
视频监控设备/通道上下线消息
{
"id": -1, //[Long][Not Null]沿用告警的消息格式,告警id固定为-1
"did": "TESTDEVICEID001", //[String][Not Null]设备序列号
"dname": "设备名称", //[String][Not Null]设备名称
"cid": 3, //[Integer][Not Null]设备通道号,cid为-1时代表设备级上下线
"cname": "通道名称", //[String][Not Null]通道名称
"msgType": "online", //[String][Not Null]上下线类型(online:上线 offline:下线)
"type": 11, //[Integer][Not Null]上下线类型(11:上线 12:下线)
"time": 1787208164, //[Long][Not Null]消息时间,Unix时间戳(秒)
"utcTime": 1787208164, //[Long][Not Null]消息UTC时间,Unix时间戳(秒)
"userId": 10545356, //[Long][Not Null]推送用户的id
"iotFlag": "false", //[String]兼容字段,已废弃,开发者可忽略
"skip": {
//[Object]兼容字段,已废弃,开发者可忽略
"action": [],
"view": "invalidView"
}
}
物联网设备上下线消息
{
"content": {}, //[Object]上下线消息内容,固定为空对象
"did": "TESTDEVICEID001", //[String][Not Null]设备序列号
"dname": "设备名称", //[String][Not Null]设备名称
"msgType": "online", //[String][Not Null]上下线类型(online:上线 offline:下线)
"pid": "TESTPID1", //[String][Not Null]设备产品id
"time": "20260820T144407", //[String][Not Null]设备本地时间,yyyyMMddTHHmmss格式
"token": "3baf90df85a34b358152dddfab1abcda", //[String][Not Null]消息token
"utcTime": "20260820T064407" //[String][Not Null]消息UTC时间,yyyyMMddTHHmmss格式
}
物联网设备 IoT 物模型消息格式如下
{
"msgType": "iotEvent", //[int][Not Null]物模型设备iot消息
"utcTime": "20230111T031629", //[long][Not Null]设备消息utc时间
"appId": "lcdxxxxxxxxx", //[String][Not Null]开发者appid
"alarmId": "116257862023505xxxx", //[String][Not Null]消息id
"pid": "mhpf7Dsz", //[String][Not Null]设备产品id
"dname": "TESTQWERXXXX", //[String][Not Null]设备名称
"time": "20230111T111629", //[String][Not Null]设备消息上报时间
"content": {
//物联网设备上报内容,不同设备上报的content不同
"outputData": {},
"localTime": "20230111T111629", //[String][Not Null]设备消息本地时间
"monitor": {
"eventId": "496", //[String]事件id
"verifierV2": "3243284SDHIUDSFHDNFI234324+ZeoG0=",
"vendor": ["COS", "OSS", "BOS", "US3", "OBS"],
"channel": 0, //[int]通道号
"action": 1 //[int]具体行为
},
"sessionId": "XXXX.XXX.XXXX.XXXXX",
"event": "33000" //[String][Not Null]具体iot设备消息类型,对应设备物模型中事件的ref,可通过 获取产品物模型 接口查看对应的设备物模型消息
},
"did": "TESTQWERXXXX", //[String][Not Null]设备序列号
"token": "2348912dsads123123123" //[String]消息token
}
设备网关配件消息格式如下
{
"msgType": "", //[String][Not Null]设备网关配件报警类型
"deviceId": "TESTQWERXXXX", //[String][Not Null]网关id
"accessoriesId": "TESTQWERSXXXX", //[String][Not Null]配件id
"time": "20201024T120000Z", //[String][Not Null]报警产生的UTC时间,yyyyMMddTHHmmssZ格式
"localTime": "[String]报警产生的设备本地时间,yyyyMMddTHHmmss格式",
"channels": "0", //[Integer][Null]可选,配件报警,本地联动视频通道ID数据
"subType": "mute", //[String][Null]可选,报警子类型
"desc": {
//[Null]可选,备注信息
}
}
备注: 当 msgType 为 earlyWraning、earlyWraningEnd、alarmOccurs、alarmEnd 时:
"desc": {
//[String]漏电电流:leakageCurrent,电流过载:currentOverload,温度过高:excessiveTemp,温度异常:tempVariation,烟感报警:smokeAlarm,燃气报警:gasAlarm,紧急按钮:urgencyButton
"type":"leakageCurrent"
}
人脸检测推送消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid
"msgType": "aiFaceDetect", //[String]推送类型
"deviceId": "TESTQWERXXXX", //[String]设备id
"channelId": "0", //[String]通道id"
"localTime": "20190912123355", //[String]报警产生的设备本地时间,yyyyMMddTHHmmss格式"
"time": "20190912123355", //[String]报警产生的UTC时间,yyyyMMddTHHmmssZ格式"
"token": "f2dc8c09eeae4b5bad6abf522c93d825", //[String][Nullable]云录像token
"picUrlArray": [
"第一张图片地址",
"第二张图片地址" // 图片地址,String类型,第一张大图,第二张小图
], //注:乐橙开放平台图片数据保存最大时长为一天,开发者收到推送消息后,请尽快保存到开发者服务器
"desc": [
{
"sex": "Man", //[可选][String]性别, Man: 男; Woman: 女
"age": "24", //[可选][String]年龄
"race": 25, //[可选][int]种族
"eye": 1, //[可选][int]眼睛状态
"mouth": 1, //[可选][int]嘴巴状态
"mask": 1, //[可选][int]口罩状态
"beard": 0, //[可选][int]胡子状态
"attractive": 0, //[可选][int]魅力值
"nation": 1, //[可选][int]民族
//[可选]
"feature": [
"Anger",
"Laugh" // 面部表情类型,String类型
]
}
]
}
熟人人脸比对后推送消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid
"msgType": "aiAFaceCompa", //aiAFaceCompa
"deviceId": "", //[String]设备id
"channelId": "", //[String]通道id
"localTime": "", //[String]报警产生的设备本地时间,yyyyMMddTHHmmss格式
"time": "20192512120012", //[String]报警产生的UTC时间,yyyyMMddTHHmmssZ格式
"picUrlArray": [
"第一张图片地址",
"第二张图片地址" // 图片地址,String类型,第一张大图,第二张小图
], //注:乐橙开放平台图片数据保存最大时长为一天,开发者收到推送消息后,请尽快保存到开发者服务器
"desc": {
// 抓拍人脸信息
"snapFace": {
"sex": "Man", //[可选][String]性别, Man: 男; Woman: 女
"age": "23", //[可选][String]年龄
"feature": [
//[可选]
"Anger",
"Laugh" // 面部表情类型,String类型
],
"race": 1, //[可选][int]种族
"eye": 2, //[可选][int]眼睛状态
"mouth": 1, //[可选][int]嘴巴状态
"mask": 1, //[可选][int]口罩状态
"beard": 1, //[可选][int]胡子状态
"attractive": 1, //[可选][int]魅力值
"nation": 1 //[可选][int]民族
},
"candidates": [
// 候选人信息
{
"groupId": "13123213213", //[String]库Id
"personId": "132132132132", //[String]人员Id
"similarity": "30" //[可选][String]相识度, 归一化到0~100
}
],
"Passerby": {
"UID": "12312321321", //[可选][String]路人唯一标识符
"GroupID": "12313213", //[可选][String]路人库ID
"GroupName": "adsd" //[可选][String]路人库名称
}
}
}
陌生人人脸比对后推送消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid
"msgType": "aiSFaceCompa", //aiAFaceCompa
"deviceId": "", //[String]设备id
"channelId": "", //[String]通道id
"localTime": "", //[String]报警产生的设备本地时间,yyyyMMddTHHmmss格式
"time": "20192512120012", //[String]报警产生的UTC时间,yyyyMMddTHHmmssZ格式
"picUrlArray": [
"第一张图片地址",
"第二张图片地址" // 图片地址,String类型,第一张大图,第二张小图
], //注:乐橙开放平台图片数据保存最大时长为一天,开发者收到推送消息后,请尽快保存到开发者服务器
"desc": {
// 抓拍人脸信息
"snapFace": {
"sex": "Man", //[可选][String]性别, Man: 男; Woman: 女
"age": "23", //[可选][String]年龄
"feature": [
//[可选]
"Anger",
"Laugh" // 面部表情类型,String类型
],
"race": 1, //[可选][int]种族
"eye": 2, //[可选][int]眼睛状态
"mouth": 1, //[可选][int]嘴巴状态
"mask": 1, //[可选][int]口罩状态
"beard": 1, //[可选][int]胡子状态
"attractive": 1, //[可选][int]魅力值
"nation": 1 //[可选][int]民族
},
"Passerby": {
"UID": "12312321321", //[可选][String]路人唯一标识符
"GroupID": "12313213", //[可选][String]路人库ID
"GroupName": "adsd" //[可选][String]路人库名称
}
}
}
客流量统计推送的消息格式如下
{
"msgType": "numberstat", //消息类型
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"deviceId": "TESTQWERXXXX", //[String]设备序列号,
"detail": [
{
"channelId": "12", //[String]通道id,
"action": "1", //[String]进、出、停留的类型标记。0:进,1:出,2:停留,
"beginTime": "20190523111256", //[String]记录的开始时间,设备时间,格式如:yyyyMMddTHHmmss,
"beginUtcTime": "20190523111256Z", //[String]记录的开始时间,UTC时间,格式如:yyyyMMddTHHmmssZ,
"endTime": "20190523111256", //[String]记录的结束时间,设备时间,格式如:yyyyMMddTHHmmss,
"endUtcTime": "20190523111256Z", //[String]记录的结束时间,UTC时间,格式如:yyyyMMddTHHmmssZ,
"number": 12 //[Int]该时间段检测到的总人数
}
]
}
热度数据推送的消息格式如下
{
"msgType": "heatmap", //[String]推送类型,
"channelId": "0", //通道号
"localBeginTime": "20031215T144307", //[String]开始时间,设备时间,格式如:yyyyMMddTHHmmss,
"localEndTime": "20031215T144307", //[String]结束时间,设备时间,格式如:yyyyMMddTHHmmss,
"utcBeginTime": "20031215T144307Z", //[String]开始时间,UTC时间,格式如:yyyyMMddTHHmmssZ,
"utcEndTime": "20031215T144307Z", //[String]结束时间,UTC时间,格式如:yyyyMMddTHHmmssZ,
"desc": {
"width": "200",
"height": "100",
"heatData": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"min": "1", //[String],可选(新增字段),热度最小值
"max": "188", //[String],可选(新增字段),热度最小值
"average": "156" // [String],可选(新增字段),热度最小值
}
}
设备分享通知消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"msgType": "deviceShare", //[String]推送类型,deviceShare,
"msgDeviceId": "TESTQWERXXXX", //[String]设备序列号,
"msgChannelId": 1, //[Int]设备通道号,
"time": 123455456546 //[Long]发生分享事件的Unix时间戳
}
设备绑定设备通知消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"msgType": "bindDevice", //[String]推送类型,bindDevice,
"msgDeviceId": "TESTQWERXXXX", //[String]设备序列号,
"time": 123455456546 //[Long]发生绑定事件的Unix时间戳
}
设备解绑设备通知消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"msgType": "unbindDevice", //[String]推送类型,unbindDevice,
"msgDeviceId": "TESTQWERXXXX", //[String]设备序列号,
"time": 123455456546 //[Long]发生解绑事件的Unix时间戳
}
用户转移设备通知消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"msgType": "接收方transferDeviceTo", //发起方transferDeviceFrom,接收方transferDeviceTo,
"msgDeviceIds": "TESTQWERXXXX", //[String]设备序列号,多个用半角逗号隔开
"time": 123455456546 //[Long]发生设备转移事件的Unix时间戳
}
删除设备分享通知消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"msgType": "deviceShareCancel", //[String]推送类型,deviceShareCancel,
"msgDeviceId": "TESTQWERXXXX", //[String]设备序列号,
"msgChannelId": 1, //[Int]设备通道号,
"time": 123455456546 //[Long]发生删除设备分享事件的Unix时间戳
}
授权数据变更推送通知消息格式如下
{
"appId": "lcdxxxxxxxxx", //[String]开发者appid,
"msgType": "deviceAuthorizationChanged", //[String]推送类型,deviceAuthorizationChanged,
"time": "20120206030513", //[Long]发生删除设备分享事件的Unix时间戳,
"msgChannelList": [
{
"deviceId": "设备序列号",
"channelId": "通道号"
}
]
}
解绑/转移设备后,通知被分享方消息格式如下
{
"appId":"lcdxxxxxxxxx",//[String]开发者appid,
"msgType":"deviceDeletedSharedCancel",//推送类型,deviceDeletedSharedCancel
"msgDeviceIds":["xxxxxxxxxx","xxxxxxxxxx",...]//[[String]设备序列号数组]
"time":123455456546//[Long]发生设备转移事件的Unix时间戳
}