事件消息推送

概述

开发者应用下的设备产生的动检报警、上下线时间、各类智能事件消息等，通过开放平台可以推送到开发者的后台回调地址服务，当开发者的后台接收到乐橙开放平台推送的事件消息后可进行后续的处理，如再次推送到自己的应用。具体通过以下两步完成报警回调的设置和报警消息的接收。

设置消息回调地址

开发者通过调用开放平台setMessageCallback接口设置回调地址，该回调地址是开发者后台可以接受外部消息的一个服务目标地址，后续开放平台产生的各类事件消息都会往这个回调地址推送相应格式的消息。

开发者接收开放平台推送过来的消息

开放平台推送各类事件消息到开发者的后台回调地址，开发者要做的事情是接收到消息后及时推送给自己开发的app，具体流程如下（以动检报警、设备上下线）：

特别注意：开发者的回调服务收到开放平台推送过来的消息后请务必返回200的响应消息，若开放平台发现开发者的回调服务存在多次不返回响应的情况，开放平台将不再推送消息给此回调地址。

乐橙开放平台推送的动检报警消息格式如下

{
    "id":2447736561,//[int][Not Null]报警消息id,对应“查询用户报警信息”接口返回的alarmId
    "appId": "lc12345678901234567890",//[String]开发者appid,
    "cid":0,//[int][Not Null]设备通道号
     "msgType":"videoMotion",//[String][Not Null]报警类型（alarmPIR：人体红外   videoMotion：动态监测）
     "time":1475052555,//[long][Not Null]报警时间
     "did":"2F0476DPAL01615",//[String][Not Null]设备序列号
     "cname":"2F0476DPAL01615",//[String][Not Null]通道名称
     "remark":"",//[String][Nullable]备注
     "token":"qwqeqwedqwedwedwe" //[String]云录像token,
}

只有platForm为4的设备触发报警消息才会带上“token”字段；

乐橙开放平台推送的设备上下线消息格式如下

{
    "id":-1,//[int][Not Null]沿用告警的消息格式，告警id置为-1
    "cid":0,//[int][Not Null]设备通道号，cid为-1时代表设备上下线
    "msgType":"online",//[String][Not Null]上下线类型（online：上线   offline：下线）
    "time":1475052555,//[long][Not Null]报警时间
    "did":"2F0476DPAL01615",//[String][Not Null]设备序列号
    "cname":"2F0476DPAL01615"//[String][Not Null]通道名称
}

人脸检测推送消息格式如下

{
    "appId": "1112111111111",//[String]开发者appid
    "msgType": "aiFaceDetect",//[String]推送类型
    "deviceId": "2123453",//[String]设备id
    "channelId":"0", //[String]通道id"
    "localTime":"20190912123355", //[String]报警产生的设备本地时间,yyyyMMddTHHmmss格式"
    "time":"20190912123355" ,//[String]报警产生的UTC时间,yyyyMMddTHHmmssZ格式"
    "token":"12345678901234567890",
    "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": "132132132132",//[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": "132132132132",//[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": "afdsafsdfs",//[String]开发者appid,
    "deviceId" : "sfdsafdasfds", //[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":"xxxxx",//[String]开发者appid,
        "msgType":"deviceShare",//[String]推送类型,deviceShare,
        "msgDeviceId":"xxxxxxxxxx",//[String]设备序列号,
        "msgChannelId":1,//[Int]设备通道号,
        "time":123455456546//[Long]发生分享事件的Unix时间戳
}

设备绑定设备通知消息格式如下

{
        "appId":"xxxxx",//[String]开发者appid,
        "msgType":"bindDevice",//[String]推送类型,bindDevice,
        "msgDeviceId":"xxxxxxxxxx",//[String]设备序列号,
        "time":123455456546//[Long]发生绑定事件的Unix时间戳
}

设备解绑设备通知消息格式如下

{
        "appId":"xxxxx",//[String]开发者appid,
        "msgType":"unbindDevice",//[String]推送类型,unbindDevice,
        "msgDeviceId":"xxxxxxxxxx",//[String]设备序列号,
        "time":123455456546//[Long]发生解绑事件的Unix时间戳
}

用户转移设备通知消息格式如下

{
        "appId":"xxxxx",//[String]开发者appid,
        "msgType":"接收方transferDeviceTo",//发起方transferDeviceFrom,接收方transferDeviceTo,
        "msgDeviceIds":"xxxxxxxxxx",//[String]设备序列号,多个用半角逗号隔开
        "time":123455456546//[Long]发生设备转移事件的Unix时间戳
}

删除设备分享通知消息格式如下

{
        "appId":"xxxxx",//[String]开发者appid,
        "msgType":"deviceShareCancel",//[String]推送类型,deviceShareCancel,
        "msgDeviceId":"xxxxxxxxxx",//[String]设备序列号,
        "msgChannelId":1,//[Int]设备通道号,
        "time":123455456546//[Long]发生删除设备分享事件的Unix时间戳
}

授权数据变更推送通知消息格式如下

{
        "appId":"xxxxxxxxxxx",//[String]开发者appid,
        "msgType":"deviceAuthorizationChanged",//[String]推送类型,deviceAuthorizationChanged,
        "time":"20120206030513",//[Long]发生删除设备分享事件的Unix时间戳,
        "msgChannelList":[{
            "deviceId":"设备序列号",
            "channelId":"通道号"
        }]
}

解绑/转移设备后，通知被分享方消息格式如下

{
        "appId":"xxxxx",//[String]开发者appid,
        "msgType":"deviceDeletedSharedCancel",//推送类型,deviceDeletedSharedCancel
        "msgDeviceIds":["xxxxxxxxxx","xxxxxxxxxx",...]//[[String]设备序列号数组]
        "time":123455456546//[Long]发生设备转移事件的Unix时间戳
}