消息订阅（企业）

消息订阅流程

1. 在开放平台web端【控制台-行业视频集成应用-应用配置-消息推送地址】配置消息回调地址。
2. 使用企业消息订阅接口订阅企业事件消息。
3. 开放平台把消息以发送HTTP POST请求的方式发送到回调地址。
4. 开放平台推送服务出口网段为：183.230.40.0/24，若订阅服务侧有网络限制，请务必添加白名单。

企业告警订阅

接口功能

支持订阅企业下产生的业务告警消息，当前支持人员守护告警

请求地址

 https://open.andmu.cn/v3/open/api/app/region/alarm/subscribe

请求方式

POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
event	String	N	订阅事件集合	为空或者不传，则为取消订阅

event可选类型如下：

• face_guard（人员守护事件）

event格式: 一个json字符串数组。例如: ["face_guard"]，然后将json格式化成字符串，填入参数。

请求内容

{
  "event": "[\"face_guard\"]"
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功"
}

企业告警订阅查询

接口功能

查询已经订阅的企业告警事件类型

请求地址

 https://open.andmu.cn/v3/open/api/app/region/alarm/subscribe/query

请求方式

POST，需要鉴权

请求参数

无请求参数

请求内容

{}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	Object	响应数据

data数据模型

参数名称	参数类型	参数含义	说明
event	String	订阅事件集合	例：[\"face_guard\"]

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "event": "[\"face_guard\"]"
    }
}

消息格式

消息统一数据结构：

参数名称	参数类型	参数含义	说明
appId	String	应用id
sig	String	签名	MD5(appId+secret),计算值为32位小写
msgList	List	消息列表

msgList数据模型

参数名称	参数类型	参数含义	说明
msgType	String	消息类型	参考消息类型
timeStamp	String	消息时间戳	13位毫秒
data	String	消息内容	不同的消息类型，data的格式不同，请根据消息类型分别解析

{
    "appId": "xxx",
    "sig": "xxx",
    "msgList": [{
        "msgType": "xxx",
        "timeStamp": "xxx",
        "data": {
            "xxx": "xxx"
        }
    }, {
        "msgType": "xxx",
        "timeStamp": "xxx",
        "data": {
            "xxx": "xxx"
        }
    }]
}

消息类型

消息类型	说明
MESSAGE_FACE_GUARD	人员守护消息

人员守护事件消息

从开放平台获取人员守护事件消息。人员守护事件消息由人员守护布控任务触发。 消息类型：MESSAGE_FACE_GUARD

data结构

参数名称	参数类型	参数含义	说明
region	String	企业id
detectTime	String	事件触发时间	13位毫秒
alarmContext	String	事件的内容	不同的AI事件，告警的内容不同，请根据AI事件编码分别解析

alarmContext结构

参数名称	参数类型	参数含义	说明
alarmTime	int	事件触发时间戳	13位毫秒
taskName	String	布控任务名称
peopleName	String	人员姓名
peoplePhoto	String	人员照片地址链接
alarmType	String	事件类型名称
deviceList	List<deviceInfo>	守护设备列表

deviceInfo结构

参数名称	参数类型	参数含义	说明
deviceId	String	设备id
deviceName	String	设备名称

示例

{
    "...": "...",
    "msgList": [{
        "msgType": "MESSAGE_FACE_GUARD",
        "timeStamp": "1583317657000",
        "data": {
            "region": "1234567",
            "detectTime": "1584599831303",
            "alarmContext": {
                "alarmTime":1723427340154,
                "taskName":"人脸守护任务",
                "peopleName":"人员名称",
                "peoplePhoto":"https://xxxxx",
                "alarmType":"人员守护",
                "deviceList": [{
                    "deviceId":"xxxxxx",
                    "deviceName":"设备名称"
                }]
            }
        }
    }]
}

企业告警取消订阅

接口功能

企业告警取消订阅接口

请求地址

  https://open.andmu.cn/v3/open/api/app/region/alarm/unsubscribe

请求方式

POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
event	String	Y	取消订阅事件集合	json字符串，例：[\"face_guard\"]

event可选类型如下：

• face_guard（人脸守护告警）

请求内容

{
  "event": "[\"face_guard\"]"
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功"
}