接口文档
更新时间：2024-04-28
1. 接口文档发布记录
| 版本号 | 变更时间 | 变更内容 |
|---|---|---|
| v1.0 | 2023.11.12 | 创建接口文档 |
2. 前言
- 凌云平台中【应用】-【智能视图分析】-【推送配置】-【新建推送任务】，进行推送地址配置；
- 推送地址配置上限为事件类型种类的上限。推送地址不可重复；
- 在配置推送地址前，贵方需要保证推送地址支持POST和GET两种请求，保证推送地址返回HTTP状态码为200。保证所选区域和【智能视图分析】-【区域管理】中配置了相关设备、对应关注事件。
3. 数据推送接口
3.1 推送事件记录
3.1.1 基本信息
Method: POST （推送地址还需要支持GET方式请求）
推送地址需要支持GET方式请求原因：基于安全考虑，在度目智能应用平台页面添加推送地址的时候会GET请求推送地址。在推送识别记录，告警记录等的时候只有POST请求。
接口描述: 将事件记录记录推送到订阅用户的接收地址
3.1.2 请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| pushType | eventLog | 是 | ||
| msgId | 随机数 | 是 |
Path 变量
| 参数名称 | 说明 | 数据类型 | 是否必填 |
|---|
RequestParam
| 参数名 | 说明 | 数据类型 | 是否必填 |
|---|
Body（识别记录）
| 参数名 | 说明 | 数据类型 | 是否必填 |
|---|---|---|---|
| taskName | 任务名称 | String | 否 |
| businessUnitName | 区域名称 | String | 否 |
| businessUnitId | 区域ID | Long | 否 |
| eventTypeId | 事件类型ID | String | 否 |
| eventTypeName | 事件类型名称 | String | 否 |
| happenedAt | 抓拍时间（时间戳） | Long | 否 |
| deviceName | 设备名称 | String | 否 |
| deviceId | 设备ID | String | 否 |
| deviceChannelName | 抓拍通道名称 | String | 否 |
| deviceChannel | 抓拍通道ID | String | 否 |
| renderImagePath | 事件图像（链接短期有效） | String | 否 |
| pushText | 推送文字 | String | 否 |
| coreId | 事件记录ID（管控中枢） | String | 否 |
3.1.3 返回数据
Response：无要求