修订记录

2023-08-24

第六十一次正式发布

本次变更如下：

9、10 敏感数据脱敏

隐藏文档中涉及token、user_id、设备ID、AKSK、BASE64数据、图片等敏感信息

2023-08-22

第六十次正式发布

本次变更如下：

• 12.1批量开通设备通道服务

  请求和响应示例的假数据添加***脱敏处理

• 12.2批量关闭设备通道服务
• 请求和响应示例的假数据添加***脱敏处理

2023-08-16

第五十九次正式发布

本次变更如下：

• 6.7批量添加设备 表4里面的algorithm行的描述列新增了md5使用的风险说明
• 批量变更IP地址为123.123.123.123
• 批量变更不对外公开地址为www.example.com

2023-07-25

第五十八次正式发布

本次变更如下：

8.5云台控制：表3里面的mode行的描述列做了点动模式的描述新增以及转动模式的描述更改

2023-07-1

第五十七次正式发布

本次变更如下：

替换好望云服务为行业视频管理服务。

2023-06-26

第五十六次正式发布

本次变更如下：

• 修正SDK中心链接地址。
• 9.3获取回放地址统一接口响应结构与字段更正
• 9.4批量删除播放地址接口功能介绍修改
• 11.5请求参数中的record_type去掉了枚举值all
• 19.1请求示例字段更正

2023-06-02

第五十五次正式发布

本次变更如下：

• 6.4章节请求参数modify_type描述修改

• 6.5和6.7章节请求参数device_name和device_password描述修改
• 6.6和6.7章节请求参数description描述修改
• 7.1章节功能描述修改
• 9.1新增获取实况地址统一接口
• 9.2新增查询回放列表统一接口
• 9.3新增获取回放地址统一接口
• 9.4章节接口功能描述修改
• 9.5-9.12章节相应接口更迭为旧接口，加上【旧】字样
• 9.5-9.12章节功能描述修改，各种参数描述部分修正
• 10.1章节部分告警描述修改补充，部分TLV字段描述修改补充

2023-02-13

第五十四次正式发布

本次变更如下：

• 5.1返回参数is_leaf增加返回值的描述
• 19巡航轨迹和预置位下的章节重新排序，并添加只支持好望设备说明
• 19.3响应参数preset_index描述修改
• 19.5添加获取云台控制权接口的链接
• 19.6响应示例修改
• 19.7响应参数cruise_type巡航轨迹类型增加枚举描述
• 19.8和19.10章节请求参数speedLevel描述修改

2023-02-02

第五十三次正式发布

本次变更如下：

• 11.1查询人流统计日周年信息关于MONTH枚举类型补充改正
• 11.2响应体描述补充
• 17.1增加仅支持好望设备/通道的提示
• 17.2增加仅支持好望设备/通道的提示

2023-01-13

第五十二次正式发布

本次变更如下：

• 8.3查询通道详情章节响应体中新增通道类型字段

2023-01-10

第五十一次正式发布

本次变更如下：

• DEVICE_ALARM 消息类型添加字段 alarm_attr

2023-01-04

第五十次正式发布

本次变更如下：

• auth_key 参数完善
• 告警智能图片下载兼容 THIRDPARTY_INTELLIGENT 三方告警类型

2023-01-04

第四十九次正式发布

本次变更如下：

• 20.5添加预置位章节增加直连场景的入参。

2023-01-03

第四十八次正式发布

本次变更如下：

• 批量添加目标图片功能，参数提示描述完善

2022-12-30

第四十七次正式发布

本次变更如下：

• 8.2 查询通道列表章节，增加返回channel_type字段。
• 原19.8章节后插入三个章节描述新版本目标库新增，修改，删除功能的接口。

2022-11-25

第四十六次正式发布

本次变更如下：

• 11.1 查询人流统计日月周年信息章节，type字段描述修改。

2022-11-25

第四十五次正式发布

本次变更如下：

• 修改API管理， 将调用的地址不隐藏，让文档更易懂。

2022-09-30

第四十四次正式发布

本次变更如下：

• 新增长尾算法接口

2022-08-08

第四十三次正式发布

本次变更如下：

• 配置用户消息通知 URL 添加 HEAD_SHOULDER_DATA、BEHAVIOR_ANALYSIS_DATA、MICRO_CHECKPOINT_DATA 枚举值

2022-08-08

第四十二次正式发布

本次变更如下：

• 获取时间热度图统计中修改type枚举值分隔符
• 获取空间热度图统计中修改type枚举值分隔符

2022-07-20

第四十一次正式发布

本次变更如下：

• 新增设备云上能力集查询接口
• 设备、通道详情接口新增云上能力集查询相关字段
• 新增动检录像计划相关接口

2022-06-08

第四十次正式发布

本次变更如下：

• 查询通道的录像计划接口新增字段

2022-06-02

第三十九次正式发布

本次变更如下：

• 云台枚举值新增描述

2022-05-31

第三十八次正式发布

本次变更如下：

• HLS实况URL增加禁用音频选项
• 批量获取P2P回放URL接口中增加开始结束时间选项

2022-04-21

第三十七次正式发布

本次变更如下：

• 修改设备信息的入参返回值
• 云台点动接口参数补充

2022-04-19

第三十六次正式发布

本次变更如下：

• 修改目标库相关接口的入参返回值格式问题

2022-03-29

第三十五次正式发布

本次变更如下：

• 原先接口缺少的约束和字段补全
• 新增云台点动接口
• 新增设备目标授权配置接口

2022-03-25

第三十四次正式发布

本次变更如下：

• 添加空间热力图base64转RGB的伪代码说明

2022-03-14

第三十三次正式发布

本次变更如下：

• 接口api发布：新增目标库与修改目标库接口请求示例错误修正

2022-03-12

第三十二次正式发布

本次变更如下：

• 接口api发布：新增目标库，修改目标库，删除目标库
• 错误码新增：IVM.20000036

2022-03-02

第三十一次正式发布

本次变更如下：

• 目标库接口目标年龄用例String类型修改为Integer类型
• 云台转动填写新的档位，云台光圈聚焦增加一键聚焦功能和点动聚焦功能
• 目标库添加增加external_target_id

2022-02-23

第三十次正式发布

本次变更如下：

• 新增错误码：IVM.20090016

2022-02-18

第二十九次正式发布

本次变更如下：

• 新增支持wss协议播放接口
• 新增媒体播放管理部分接口支持url自定义超时时间和次数
• 修改云端录像record_type枚举值

2022-02-11

第二十八次正式发布

本次变更如下：

• 修正查询通道的前端录像回放地址(仅支持HLS协议)接口

2022-01-29

第二十七次正式发布

本次变更如下：

修改itgt_type 字段枚举值

2022-01-17

第二十六次正式发布

本次变更如下：

• 修改告警推送消息体结构的message_type为device_status时的请求示例

2022-01-12

第二十五次正式发布

本次变更如下：

• 批量获取设备实况播放地址删除仅支持国标设备描述

2021-12-27

第二十四次正式发布

本次变更如下：

• 周界检测告警参数配置和获取周界检测告警参数添加结构体 region 、point

2021-12-16

第二十三次正式发布

本次变更如下：

• 巡航轨迹和预置位功能重新上线
• 设备密码修改
• 查询设备码流能力和码流列表特性

2021-12-09

第二十二次正式发布

本次变更如下：

• 添加三种智能业务：头肩业务、行为分析与人车物分离、微卡口业务
• target_data 目标及目标整体业务和 vehicle_data 机非人业务新增字段

2021-12-06

第二十一次正式发布

本次变更如下：

• 添加HLS协议实况、云端回放、前端回放地址

2021-11-25

第二十次正式发布

本次变更如下：

• 设备密码、码流远程配置、巡航轨迹和预置位接口删除

2021-11-24

第十九次正式发布

本次变更如下：

• 设备密码和码流远程配置接口添加

2021-11-23

第十八次正式发布

添加各种类型设备目标库字段支持情况

2021-11-05

第十七次正式发布

本次变更如下：

• 告警推送消息结构体的 target_data 类型新增五个字段：

  itgt_version String 目标识别算法版本号

  quality_score Int 目标识别目标抠图质量分

  target_url String 目标抠图的 URL

  target_all_pic_url String 目标整体抠图的 URL

  panorama_url String 目标全景的 URL

2021-11-01

第十七次正式发布

本次变更如下：

• 巡航轨迹和预置位接口添加

2021-08-27

第十六次正式发布

本次变更如下：

• 修改通道名称修改为只支持好望协议，通道名称修改特殊字符增加.

2021-08-19

第十五次正式发布

本次变更如下：

• OSD名称相关，名字增加对换行符的支持

2021-08-18

第十四次正式发布

本次变更如下：

• 添加设备升级失败的字段，及响应示例

2021-08-13

第十三次正式发布

本次变更如下：

• 添加查询用户URL的响应示例

2021-08-06

第十二次正式发布

本次变更如下：

• 修改配置周界告警参数配置的请求示例
• 给配置用户消息通知URL接口新增了接口说明

2021-07-23

第十一次正式发布

本次变更如下：

• 批量添加设备(仅支持GB28181协议)接口增加algorithm字段
• 添加目标库接口文档
• 发送云台聚焦和光圈控制命令params改为必填参数

2021-07-08

第十次正式发布

本次变更如下：

• 消息回调接口增加auth_key字段

2021-06-25

第九次正式发布

本次变更如下：

• 解决：消息推送ISV，回调URL接口，告警图片下载接口的MG信息问题
• 补充描述，智能及告警图片下载路径有效期五分钟

2021-06-11

第八次正式发布

本次变更如下：

• 告警推送新增物品遗留、移走、电瓶车等告警类型，图片下载接口新增第三方智能算法。
• 新增告警参数配置（两个接口）

2021-05-14

第七次正式发布

本次变更如下：

新增云端抓拍目录，新增云端抓拍设备接口

2021-04-28

第六次正式发布

本次变更如下：

• 部分接口增加详细说明，比如设备实况地址获取接口仅支持国标

2021-04-15

第五次正式发布

本次变更如下：

下线FLV、WASM等内容。

2021-04-12

第四次正式发布

本次变更如下：

告警推送消息体结构，修改 rect 对象的字段名

2021-04-06

第三次正式发布

本次变更如下：

• API参考中增加“附录”目录，附录中存放状态码、错误码以及其他北向接口调用参考信息；
• 告警消息结构体从“用户指南”移动到了“消息管理”目录中。
• LiveWebURLDto参数对象中的“stream_type”码流参数类型补充了取值范围。
• 增加了“使用前必读”、“API概览”、“如何调用API”说明目录。

2021-03-05

第二次正式发布

本次变更如下：

• API目录名称统一去除“北向”两字。
• 新增“智能图片下载”、“告警图片下载”北向接口目录及所属能力接口。

2020-12-15

第一次正式发布