更新时间:2024-05-21 GMT+08:00
分享

基本消息结构体

推送消息给企业ISV平台时,各参数定义如下:

请求头header,当用户设置auth_key的值,会携带这两个请求头

字段名

类型

是否可为空

说明

X-Ivm-Timestamp

Int64/long整型

不为空

UNIX时间戳,整形正数,固定长度10,1970年1月1日以来的秒数,表示回调请求发起时间。

X-Ivm-Signature

String

不为空

接口请求token,token生成方式,为将callback_url,X-Ivm-Timestamp,auth_key三个字段进行拼接,字段中间以竖线(|)分割,后计算sha256值。即

X-Ivm-Signature = sha256(callback_url|X-Ivm-Timestamp|auth_key),回调消息接收端接收请求后可自行计算该值并做比较,若不相等,则请求非法

结构体req

字段名

类型

是否可为空

说明

message_id

Int64/long整型

不为空

消息ID:该消息的唯一标识,根据时间戳生成(18到32位的数字),无重复

message_type

String

可能为空

消息类型:分为设备智能告警消息、设备异常告警消息、设备解绑消息和设备智能数据消息四大类

枚举值:

设备智能告警消息

  • device_alarm 智能告警消息,包含目标智能告警,口罩告警,周界告警,人群态势告警及第三方智能告警消息等

设备异常告警消息

  • device_status 设备异常消息,包含设备/通道上下线告警,通道名称修改,以及设备升级失败

设备解绑消息

设备智能数据消息

  • target_data 智能业务中的目标及目标整体业务
  • third_data 第三方智能业务,目前是提供整个数据包,使用方需自行解析。订阅时要和第三方智能告警数据区分开
  • vehicle_data 智能业务中的机非人业务

data

Object

可能为空

智能告警信息:

  1. 当 message_type 不同时,data 格式不同,可参考message_type里各种类型的介绍
  2. 当智能类型算法升级时,可能会在推送的结构体里添加新字段;

test

Boolean

不为空

  1. 当test字段为true时,表示这是配置回调URL时测试是否可访问的消息,被调用方需要返回响应码为200。注意,此时message_type和data字段不传。
  2. 当test字段为false时,表示这是一条推送消息,message_type和data字段正常传入。

相关文档