华为云用户手册

请求示例 用户【123456781234567812345***】设备开通【MANAGE】类型按需 /v1/123456781234567812345***/devices/channels/resources { "resource_id" : "d84c8cbabb8145b390bced5f2a774af6", "storage_day" : 7, "channels" : [ { "device_id" : "1abcdef8", "channel_id" : "1" }, { "device_id" : "12345678901234******", "channel_id" : "2" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源ID：该资源ID可从查询包周期和按需资源列表接口进行获取 storage_day 否 Float 存储天数：例如连续收录中录像的存储天数等 当resourceID为连续收录按需服务、行业数据流按需服务、动检云存储按需服务三种按需资源时必传，参数范围为[1,365]， 不传报错 当resourceID为包周期资源时不传，默认值为0， 传非0值报错 channels 是 Array of Channel objects 通道信息 表4 Channel 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取

响应示例 状态码： 200 OK { "failed_num" : 0, "channels" : [ { "device_id" : "34020000001*********", "channel_id" : "34020000001*********", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }

请求示例 查询前端的录像回放地址 GET /v1/2562572829***/devices/952352LWXT***/channels/0/device-records/web-playback-url?start_time=2021-12-04 15:09:00&end_time=2021-12-04 15:10:00&playback_protocol=HLS_DEV GET /v1/2562572829***/devices/952352LWXT***/channels/0/device-records/web-playback-url?start_time=2021-12-04 15:09:00&end_time=2021-12-04 15:10:00&playback_protocol=HLS_DEV_HTTPS

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "channel_id" : "0", "playback_url" : "http://123.123.*.*:***/dev_vod/vod.m3u8?token=...&device_id=952352LWXT***&channel_id=0&stream_type=0" } { "device_id" : "952352LWXT***", "channel_id" : "0", "playback_url" : "https://123.123.*.*:***/dev_vod/vod.m3u8?token=...&device_id=952352LWXT***&channel_id=0&stream_type=0" }

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records/web-playback-url 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 表2 Query参数 参数 是否必选 参数类型 描述 protocol 是 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型 枚举值： HLS_DEV 基于HTTP的HLS流媒体传输协议的前端录像 HLS_DEV_HTTPS 基于HTTP的HLS流媒体传输协议的前端录像 RTSP_DEV RTSP流媒体传输协议的前端录像 HTTP_FLV_DEV 基于HTTP的FLV媒体协议的前端录像（仅适用于国标设备） HTTPS_FLV_DEV 基于HTTPS的FLV媒体协议的前端录像（仅适用于国标设备） start_time 是 String 开始时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 end_time 是 String 结束时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 expire_time 否 String 自定义Url过期时间：时间范围[30, 86400]，不填写时默认值为 30（单位/秒） 备注：仅对响应Body参数中的playback_url有效 use_times 否 String 自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP_DEV协议固定为 0 备注：仅对响应Body参数中的playback_url有效 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP_DEV协议无效 trans_protocol 否 String 传输协议：枚举类型，不填写时默认值为 TCP，仅适用于gb28181，其它接入协议无效 枚举值： TCP TCP传输协议 UDP UDP传输协议 stream_type 否 String 码流类型：枚举类型，不填写时默认值为 PRIMARY_STREAM 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2

修订记录 表1 修订记录 修改时间 修改说明 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 第一次正式发布

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 否 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 group_name 是 String 目标库分组名称：最大为63位 group_type 是 String 目标库分组类型：枚举类型，不同设备支持的枚举类型不一样 NVR800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 BLACK 黑名单 SDC设备下的目标库分组类型：不填默认为其他名单 枚举值： OTHER 其他名单 DEFAULT 默认名单 WHITE 白名单 IVS1800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 RED 红名单 enable 否 String 控制目标库分组是否生效：SDC和NVR必填；IVS1800该字段不生效，IVS1800目标库均生效，无法选择 枚举值： OPEN 生效 CLOSE 失效

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_id String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 stream_type String 码流类型：枚举类型。不传入时，默认主码流 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 次码流1 SECONDARY_STREAM_2 次码流2

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-config 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

URI GET /v1/{user_id}/time-heatmap 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 start_time 是 String 开始时间：时间格式为yyyy-MM-dd HH:mm:ss type 是 String 时间类型：枚举类型 枚举值： YEAR 年统计 MONTH 月统计 WEEK 周统计 DAY 日统计

功能介绍 微卡口业务：在机动车进入智能感知范围时，抓取机动车相关信息进行上报的智能场景。 微卡口业务消息体的message_type值为micro_checkpoint_data。 目前行业视频管理服务会处理以下场景： itgt_type/target_type枚举值： 51 微卡口（摄像机SDC/NVR800开启微卡口/车辆智能下的功能，机动车进去区域且触发违法停车、非机动车占用机动车道、机动车占用非机动车道、逆行/倒车、压线等事件，则会被抓拍且分析出目标行为和特征信息，如：品牌、款式、主/副驾驶的情况，包括有无打电话、有无系安全带、有无遮阳板等） 52 微卡口车流量统计（摄像机SDC/NVR800开启微卡口/车辆智能下的交通流量统计功能，机动车进入区域则会被统计分析，最后得到统计分析结果，如：车辆计数、车辆平均速度、车流密度等） 表1 message_type为micro_checkpoint_data，data结构体如下： 字段名 类型 说明 device_id String 设备ID，正常情况下不为空，必传 channel_id String 通道ID，正常情况下不为空，必传 data_id String 数据ID：正常情况下不为空，必传。可用于查询智能图片数据，参考链接：智能图片下载 report_time String 上报时间：示例：2021-03-15T16:43:00+08:00 data Data object 业务信息 表2 Data 字段名 类型 说明 common Common object 通用数据定义 targets Array of Target object 目标数据定义 表3 Common 字段名 类型 说明 channel_id Int64 通道ID channel_id_ex Int64 相机扩展通道ID pts Int64 时间戳 sdc_device_id String 主从机设备ID sdc_uuid String 摄像机视频源通道号 intelligence_type Int 智能类型 image_height Int 图片高度 image_width Int 图片宽度 meta_type_mask Int 元数据类型掩码 枚举值： 1 框数据 2 图数据 8 保活数据 16 告警数据 intelligent_target_index Int 智能目标/业务类型索引 target_time_domain_info Int 配合索引使用，标识三层数据时域信息 枚举值： 0 实时框数据（检测框，规则框数据，用于复合流请流） 1 目标等其他数据（目标抓拍，定时上报，用于后端储存检索） sys_language_type Int 后台系统语言类型 target_type Int target类型，对应微卡口车流量统计类型 表4 Target 字段名 类型 说明 car_pre_brand String 品牌字符：中文字符，例如大众 car_pre_brand_index Int 品牌字符索引，当检测到机动车属性时传该值，见附录车款类型 car_sub_brand String 子款字符：中文字符，例如明锐 car_sub_brand_index Int 子款字符索引 car_year_brand String 年款字符：例如2011 cur_snap_index Int 当前抓拍序列号 device_id String 设备ID dir_id String 方向编号 data_id String 数据ID：正常情况下不为空，必传。可用于查询智能图片数据，参考链接：智能图片下载 feature_frame_flag Int 当前帧是否为关键帧，抠特征图来源帧 global_object_id Int64 智能目标全局ID ir_info String 方向信息 lane_id Int 车道号 mfr_car_pendant Int 挂件 枚举值： -1 未知 0 无 1 有 mfr_main_belt Int 主驾驶安全带 枚举值： -1 未知 0 无 1 有 mfr_main_call Int 主驾驶打电话 枚举值： -1 未知 0 无 1 有 mfr_main_sun_visor Int 主驾驶遮阳板 枚举值： -1 未知 0 无 1 有 mfr_nap_kin_box Int 纸巾盒 枚举值： -1 未知 0 无 1 有 mfr_vice_belt Int 副驾驶安全带 枚举值： -1 未知 0 无 1 有 mfr_vice_exist Int 是否有副驾驶 枚举值： -1 未知 0 无 1 有 mfr_vice_sun_visor Int 副驾驶遮阳板 枚举值： -1 未知 0 无 1 有 mfr_year_log Int 年检标 枚举值： -1 未知 0 无 1 有 panorama_pic String 全景图，已转化为url panorama_pic_size Int 全景图大小 pic_snapshot_dst_offset Int64 夏令时偏移时间：单位秒/s pic_snapshot_time Int 抓拍时间：单位秒/s pic_snapshot_timems Int64 抓拍时间：单位毫秒/ms pic_snapshot_tzone Int64 抓拍时区：单位毫秒/ms 东区为+ 西区为-，支持夏令时 plate_char String 车牌字符 plate_color Int 车牌颜色，当检测到机动车属性时传该值，见附录车牌颜色 plate_confidence Int 车牌置信度 plate_pic String 车牌抠图：已转化为图片url plate_pos Rect object 车牌位置万分比 plate_pos_abs Rect object 车牌位置绝对坐标 plate_pos_com Rect object 车牌位置万分比 plate_snapshot_type Int 车牌抓拍触发类型 枚举值： 0 手动触发 1 自动触发 plate_type Int 车牌类型，参考附录车牌类型 producer_name String 数据生成者名字 roid_id String 道路编号 target_type Int 智能业务类型 枚举值： 51 微卡口 52 微卡口车流量统计 trecord_type Int 告警类型，见附录告警类型 vehicle_color Int 车辆颜色，当检测到机动车属性时传该值，见附录车辆颜色 vehicle_direction Int 车辆运动方向 枚举值： 0 未知 1 向左 2 向右 3 向上 4 向下 vehicle_pic String 车辆特写图，已转化为url vehicle_pos Rect object 车辆位置 vehicle_pos_abs Rect object 车辆位置绝对坐标 vehicle_pos_com Rect object 车辆位置相对坐标万分比 vehicle_type Int 机非人类型，当检测到机非人属性时传该值，见附录机非人类型 vehicle_type_ext Int 机非人扩展类型，当检测到机非人属性时传该值，见附录机非人类型，例如机非人类型为轿车，扩展类型为两厢轿车 vlpr_alg_type Int 车牌算法类型 microport_traffic_statistics Int 微卡口车流量统计，历史版本遗留字段，为1代表该包为微卡口车流量统计 statistics_average_speed Int 平均速度 statistics_congestion_degree Int 交通状态 statistics_lane_count Int 微卡口车流量统计车道数量 statistics_lane_index Int 微卡口车流量统计当前车道 statistics_lane_space_used_ratio Int 车道空间占有率 statistics_lane_time_used_ratio Int 车道时间占有率 statistics_queue_length Int 排队长度 statistics_vehicle_car_large_count Int 大型车数量 statistics_vehicle_car_med_count Int 中型车数量 statistics_vehicle_car_small_count Int 小型车数量 statistics_vehicle_count Int 车辆计数 statistics_vehicle_density Int 车流密度 statistics_vehicle_head_interval Int 车头时间间隔 statistics_vehicle_head_space_interval Int 车头空间间隔 traffic_statistics_cycle Int 车流量统计周期 表5 Rect 字段名 类型 说明 x Int 检测框左上角坐标点x 计算方式，x1 = x *全景图像素宽度/ 10000 y Int 检测框左上角坐标点y 计算方式，y1 = y *全景图像素高度/ 10000 width Int 检测框宽度 计算方式 widht1 = widht *全景图像素宽度/ 10000 height Int 检测框长度 计算方式 height1 = height *全景图像素高度/ 10000 示例一、微卡口 { "message_id": 1676872319771064837, "message_type": "micro_checkpoint_data", "data": { "device_id": "219123456CYP***", "channel_id": "0", "data_id": "167687231972200300350000kcxdq130", "report_time": "2023-02-20T13:51:57+08:00", "data": { "common": { "channel_id": 101, "channel_id_ex": 101, "image_height": 720, "image_width": 1280, "meta_type_mask": 2, "pts": 786519119707, "sdc_uuid": "224440c1-966e-57eb-fd7b-8ca03739be7e", "sys_language_type": 0 }, "targets": [ { "car_pre_brand": "日产", "car_pre_brand_index": 75, "car_sub_brand": "轩逸", "car_sub_brand_index": 574, "car_year_brand": "2009_2012_2016_2018", "cur_snap_index": 0, "data_id": "167687231972200300350000kcxdq130", "device_id": "", "dir_id": "", "feature_frame_flag": 1, "global_object_id": 7200441985172434795, "ir_info": "", "lane_id": 3, "mfr_car_pendant": 0, "mfr_main_belt": 1, "mfr_main_call": 0, "mfr_main_sun_visor": 0, "mfr_nap_kin_box": 0, "mfr_vice_belt": 0, "mfr_vice_exist": 0, "mfr_vice_sun_visor": 0, "mfr_year_log": 0, "panorama_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687231972200300020000kcxdq130.jpg/static", "panorama_pic_size": 103310, "pic_snapshot_dst_offset": 0, "pic_snapshot_time": 1676872317, "pic_snapshot_timems": 1676872317957, "pic_snapshot_tzone": 28800000, "plate_char": "浙A306B1", "plate_color": 1, "plate_confidence": 97, "plate_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687231972200300320000kcxdq130.jpg/static", "plate_pos": { "x": 7726, "y": 5027, "width": 726, "height": 694 }, "plate_pos_abs": { "x": 989, "y": 362, "width": 93, "height": 50 }, "plate_pos_com": { "x": 7726, "y": 5027, "width": 726, "height": 694 }, "plate_snapshot_type": 1, "plate_type": 1, "producer_name": "ITGT", "roid_id": "", "target_type": 51, "trecord_type": 36, "vehicle_color": 2, "vehicle_direction": 4, "vehicle_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687231972200300010000kcxdq130.jpg/static", "vehicle_pos": { "x": 4429, "y": 1361, "width": 4000, "height": 4750 }, "vehicle_pos_abs": { "x": 567, "y": 98, "width": 512, "height": 342 }, "vehicle_pos_com": { "x": 4429, "y": 1361, "width": 4000, "height": 4750 }, "vehicle_type": 1, "vehicle_type_ext": 18, "vlpr_alg_type": 0 } ] } }, "test": false } 示例二、微卡口车流量统计 { "message_id": 1676874462279656679, "message_type": "micro_checkpoint_data", "data": { "device_id": "219123456CYP***", "channel_id": "0", "data_id": "167687446220900300350000kcxdq130", "report_time": "2023-02-20T14:27:40+08:00", "data": { "common": { "channel_id": 101, "channel_id_ex": 101, "image_height": 720, "image_width": 1280, "meta_type_mask": 2, "pts": 146494760, "sdc_uuid": "224440c1-966e-57eb-fd7b-8ca03739be7e", "sys_language_type": 0, "target_type": 52 }, "targets": [ { "car_pre_brand": "斯柯达", "car_pre_brand_index": 74, "car_sub_brand": "明锐", "car_sub_brand_index": 554, "car_year_brand": "2010", "cur_snap_index": 0, "data_id": "167687446220900300350000kcxdq130", "microport_traffic_statistics": 1, "device_id": "", "dir_id": "", "feature_frame_flag": 1, "global_object_id": 7202244372492976151, "ir_info": "", "lane_id": 3, "mfr_car_pendant": 0, "mfr_main_belt": 1, "mfr_main_call": 0, "mfr_main_sun_visor": 0, "mfr_nap_kin_box": 0, "mfr_vice_belt": 0, "mfr_vice_exist": 0, "mfr_vice_sun_visor": 0, "mfr_year_log": 0, "panorama_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687446220900300020000kcxdq130.jpg/static", "panorama_pic_size": 98965, "pic_snapshot_dst_offset": 0, "pic_snapshot_time": 1676874459, "pic_snapshot_timems": 1676874459506, "pic_snapshot_tzone": 28800000, "plate_char": "浙A068PN", "plate_color": 1, "plate_confidence": 97, "plate_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687446220900300320000kcxdq130.jpg/static", "plate_pos": { "x": 5953, "y": 3222, "width": 765, "height": 472 }, "plate_pos_abs": { "x": 762, "y": 232, "width": 98, "height": 34 }, "plate_pos_com": { "x": 5953, "y": 3222, "width": 765, "height": 472 }, "plate_snapshot_type": 1, "plate_type": 1, "producer_name": "ITGT", "statistics_average_speed": 0, "statistics_congestion_degree": 1, "statistics_lane_count": 3, "statistics_lane_index": 1, "statistics_lane_space_used_ratio": 0, "statistics_lane_time_used_ratio": 0, "statistics_queue_length": 0, "statistics_vehicle_car_large_count": 0, "statistics_vehicle_car_med_count": 0, "statistics_vehicle_car_small_count": 0, "statistics_vehicle_count": 0, "statistics_vehicle_density": 0, "statistics_vehicle_head_interval": 0, "statistics_vehicle_head_space_interval": 0, "roid_id": "", "target_type": 52, "traffic_statistics_cycle": 5, "trecord_type": 36, "vehicle_color": 2, "vehicle_direction": 4, "vehicle_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687446220900300010000kcxdq130.jpg/static", "vehicle_pos": { "x": 3648, "y": 569, "width": 3281, "height": 3625 }, "vehicle_pos_abs": { "x": 467, "y": 41, "width": 420, "height": 261 }, "vehicle_pos_com": { "x": 3648, "y": 569, "width": 3281, "height": 3625 }, "vehicle_type": 1, "vehicle_type_ext": 17, "vlpr_alg_type": 0 } ] } }, "test": false }

URI DELETE /v1/{user_id}/messages/callback 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 subscription_type 是 String 订阅类型字段 枚举值： DEVICE_ALARM 智能告警消息（含第三方告警），该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息，该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据，该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据，该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据，该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据，该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据，该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据，该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据，该消息的数据推送结构体微卡口数据推送结构体

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 subscription_type String 订阅类型字段 枚举值： DEVICE_ALARM 智能告警消息（含第三方告警），该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息，该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据，该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据，该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据，该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据，该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据，该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据，该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据，该消息的数据推送结构体微卡口数据推送结构体

URI GET /v1/{user_id}/targets/ids 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK 表2 Query参数 参数 是否必选 参数类型 描述 count 否 Integer 页面数量：取值范围[1,5000]，默认值为10 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 start 否 Integer 开始页：取值范围[0,5000]，默认值为0

URI PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID校验：目前只支持好望设备，取值范围[-1,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 current_security_key 是 String 设备当前密码：初始化设置密码时可不填 new_security_key 是 String 设备新密码：字符组成（大写字母、小写字母、数字、特殊字符至少两项，且不能与用户名或用户名的倒序相同），长度范围[8,20]

功能介绍 头肩业务：人群密度，排队长度，过线计数与人数统计相关的场景的智能业务。 头肩业务消息体的message_type值为head_shoulder_data。 目前行业视频管理服务会处理以下场景： itgt_type/target_type枚举值： 12 人群密度（摄像机SDC/NVR800开启人群密度功能，会自动抓拍区域内人群，提取人群信息，如人群密度、人数等） 13 排队长度（摄像机SDC/NVR800开启排队长度功能，会自动抓拍区域内的排队队列，提取排队信息，如排队人数、排队时长等） 15 过线计数（摄像机SDC/NVR800开启过线计数功能，绘制一条线，指定进入和离开方向，有人通过线，则会记录过线信息，如进入总人数、离开总人数等）

功能介绍 行为分析与人车物分离业务：对人车物行为进行分析生成相应数据的智能场景。 行为分析与人车物分离业务消息体的message_type值为behavior_analysis_data 。 目前行业视频管理服务会处理以下场景： itgt_type/target_type枚举值： 21 行为分析抓图（摄像机SDC/NVR800开启行为分析功能，目标进入区域且触发入侵、越线、徘徊、遗留、移走、区域进入、区域离开、快速移动等告警，则进行抓拍并分析目标信息，如：目标类型、目标状态、目标速度等） 表1 message_type为behavior_analysis_data时，data结构体如下： 字段名 类型 说明 device_id String 设备ID，正常情况下不为空，必传 channel_id String 通道ID，正常情况下不为空，必传 data_id String 数据ID：正常情况下不为空，必传。可用于查询智能图片数据，参考链接：智能图片下载 report_time String 上报时间：示例：2021-03-15T16:43:00+08:00 data Data object 业务信息 表2 Data 字段名 类型 说明 common Common object 通用数据定义 rule Rule object 规则数据定义 targets Array of Target Object 目标数据定义 Common对象： 表3 Common 字段名 类型 说明 channel_id Int64 通道ID channel_id_ex Int64 相机扩展通道ID pts Int64 时间戳 sdc_device_id String 主从机设备ID sdc_uuid String 摄像机视频源通道号 intelligence_type Int 智能类型 image_height Int 图片高度 image_width Int 图片宽度 meta_type_mask Int 元数据类型掩码 枚举值： 1 框数据 2 图数据 8 保活数据 16 告警数据 intelligent_target_index Int 智能目标/业务类型索引 target_time_domain_info Int 配合索引使用，标识三层数据时域信息 枚举值： 0 实时框数据（检测框，规则框数据，用于复合流请流） 1 目标等其他数据（目标抓拍，定时上报，用于后端储存检索） Rule 对象： 表4 Rule 字段名 类型 说明 rule_area_pos MetaArea Object 规则框位置 rule_area_pos_relative MetaArea Object 规则框位置(相对位置) rule_type Int 规则类型 表5 MetaArea 字段名 类型 说明 num Int 框线坐标点数量：框线为多边形，这里表示顶点的个数 points Array of Point object 坐标 表6 Point 字段名 类型 说明 x Int 横坐标 y Int 纵坐标 表7 Target 字段名 类型 说明 data_id Int 数据ID，正常情况下不为空，必传 panorama_pic String 全景图，已经转化为url panorama_pic_size Int 全景图大小 pic_snapshot_dst_offset Int64 夏令时偏移时间：单位秒/s pic_snapshot_time Int 抓拍时间：单位秒/s pic_snapshot_timems Int64 抓拍时间：单位毫秒/ms pic_snapshot_tzone Int64 抓拍时区：单位毫秒/ms 东区为+ 西区为- color Color object 颜色 global_object_id Int64 智能目标全局ID obj_id Int 目标ID obj_pos Rect object 目标位置 obj_pos_r Rect object 目标位置(相对位置) obj_speed Point object 目标速度 obj_status Int 目标状态 枚举值： 0 无状态 1 徘徊状态 2 绊线状态 4 遗留状态 8 移走状态 16 入侵状态 32 区域进入状态 64 区域离开状态 128 球机转动，雷球联动 256 电梯内电瓶车检测 obj_type Int 目标类型 枚举值： 0 未分类 1 车 2 人 96 机非人的机动车 97 机非人的非机动车 98 机非人的行人 128 区域显示框类型0:目标框 129 区域显示框类型1:人框 130 区域显示框类型2:非机动车框 131 区域显示框类型3:机动车框 132 区域显示框类型4:在目标业务中是人身框、在交通业务中是车牌框 133 区域显示框类型5:停车侦测使用框 134 区域显示框类型6:人群密度使用框 135 区域显示框类型7:排队长度使用框 136 区域显示框类型8:违停球使用框 137 区域显示框类型9:自动跟踪使用框 138 区域显示框类型10:复杂行为分析使用框 139 区域显示框类型11:火点检测使用框 255 其他 target_type Int 智能业务场景 枚举值： 21 行为分析抓图 表8 Rect 字段名 类型 说明 x Int 上层业务检测框左上角坐标点计算方式，x1 = x *全景图像素宽度/ 10000 y Int 上层业务检测框左上角坐标点计算方式，y1 = y *全景图像素高度/ 10000 width Int 上层业务检测框宽度计算方式 widht1 = widht *全景图像素宽度/ 10000 height Int 上层业务检测框长度计算方式 height1 = height *全景图像素高度/ 10000 表9 Color 字段名 类型 说明 red Int 红色像素 green Int 绿色像素 blue Int 蓝色像素 conf_lev Int 置信度 color_id Int 颜色id 示例一、行为分析抓图 { "message_id": 1676822987447548758, "message_type": "behavior_analysis_data", "data": { "device_id": "HOLO123***", "channel_id": "0", "data_id": "167682298743800500010002rwnwv040", "report_time": "2023-02-20T00:09:47+08:00", "data": { "common": { "channel_id": 101, "channel_id_ex": 101, "image_height": 1440, "image_width": 2560, "intelligent_target_index": 281474976710656, "meta_type_mask": 2, "pts": 517577328, "sdc_uuid": "e15ee2b3-83c2-073a-28e1-378e9612aa71", "target_time_domain_info": 1, "target_type": 21 }, "rule": { "rule_area_pos": { "num": 4, "points": [ { "x": 1, "y": 1 }, { "x": 351, "y": 1 }, { "x": 351, "y": 287 }, { "x": 1, "y": 287 } ] }, "rule_area_pos_relative": { "num": 4, "points": [ { "x": 28, "y": 34 }, { "x": 9971, "y": 34 }, { "x": 9971, "y": 9965 }, { "x": 28, "y": 9965 } ] }, "rule_type": 4 }, "targets": [ { "data_id": "167682298742100500010001rwnwv040", "panorama_pic": "https://www.example.com/v1/holo/tlv_HOLO123***_0_20230220_tlv_167682298742100500010001rwnwv040.jpg/static", "panorama_pic_size": 199629, "pic_snapshot_dst_offset": 0, "pic_snapshot_time": 1631497728, "pic_snapshot_timems": 1631497728392, "pic_snapshot_tzone": 28800000, "target_type": 21 }, { "color": { "red": 0, "green": 0, "blue": 0, "conf_lev": 0, "color_id": 0 }, "data_id": "167682298743800500010000rwnwv040", "global_object_id": 7007351688747024516, "meta_type_mask": 2, "obj_id": 132, "obj_pos": { "x": 169, "y": 110, "width": 74, "height": 177 }, "obj_pos_r": { "x": 4804, "y": 3819, "width": 2128, "height": 6173 }, "obj_speed": { "x": 0, "y": 0 }, "obj_status": 16, "obj_type": 98, "target_type": 21 }, { "color": { "red": 0, "green": 0, "blue": 0, "conf_lev": 0, "color_id": 0 }, "data_id": "167682298743800500010001rwnwv040", "global_object_id": 7007351688747024510, "meta_type_mask": 2, "obj_id": 126, "obj_pos": { "x": 217, "y": 155, "width": 80, "height": 126 }, "obj_pos_r": { "x": 6191, "y": 5395, "width": 2285, "height": 4388 }, "obj_speed": { "x": 8, "y": 14 }, "obj_status": 16, "obj_type": 98, "target_type": 21 }, { "color": { "red": 0, "green": 0, "blue": 0, "conf_lev": 0, "color_id": 0 }, "data_id": "167682298743800500010002rwnwv040", "global_object_id": 7007351688747024493, "meta_type_mask": 2, "obj_id": 109, "obj_pos": { "x": 85, "y": 137, "width": 74, "height": 148 }, "obj_pos_r": { "x": 2421, "y": 4756, "width": 2128, "height": 5152 }, "obj_speed": { "x": 3, "y": 6 }, "obj_status": 16, "obj_type": 98, "target_type": 21 } ] } }, "test": false }

URI GET /v1/{user_id}/space-heatmap 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 start_time 是 String 开始时间：时间格式为yyyy-MM-dd HH:mm:ss type 是 String 时间类型：枚举类型 枚举值： YEAR 年统计 MONTH 月统计 WEEK 周统计 DAY 日统计

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 目标库分组名称：最大为63位 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_type 否 String 目标库分组类型：枚举类型，不同设备支持的枚举类型不一样 NVR800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 BLACK 黑名单 SDC设备下的目标库分组类型：不填默认为其他名单 枚举值： OTHER 其他名单 DEFAULT 默认名单 WHITE 白名单 IVS1800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 RED 红名单

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_id String 设备id channel_id String 通道id resources Array of ChannelResource objects 响应信息 表4 ChannelResource 参数 参数类型 描述 resource_id String 资源id resource_name String 资源名称 resource_type_code String 资源类型编码 MANAGE 视图接入调阅 NORMAL 连续云存储 DATAFLOW 行业数据流 MOTION 动检云存储 resource_state String 资源状态 NORMAL 正常 ARREARS 欠费 UNAVAILABLE 不可使用冻结

响应示例 状态码： 200 OK { "device_id" : "5648781*****", "channel_id" : "666", "resources" : [ { "resource_id" : "c0d3c9f9b70b4c3599fe4a98eb2a****", "resource_name" : "90天动检检云存储月套餐", "resource_type_code" : "MOTION", "resource_state" : "NORMAL" }, { "resource_id" : "c0d3c9f9b70b4c3599fe4a98eb2a****", "resource_name" : "设备按需动检收录套餐", "resource_type_code" : "MOTION", "resource_state" : "NORMAL" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_id String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 plans Array of GetChannelRecordAlarmPlan objects 动检录像计划列表 all_day Boolean 是否全程录像：枚举类型。 默认为false，如果为true，time_sections省略（不进行校验） 枚举值： true 是 false 否 time_sections Array of TimeSection objects 通道录像计划时间段 表4 GetChannelRecordAlarmPlan 参数 参数类型 描述 alarm_type String 告警类型：枚举类型 枚举值： motion_detection 移动侦测报警 io_event 外部IO输入报警 target_alarm 目标报警 mask_alarm 口罩报警 people_queue_alarm 排队长度报警 people_count_region_alarm 区域人数统计报警 people_count_line_alarm 过线人数统计报警 over_line_alarm 越线检测报警 region_invasion_alarm 区域入侵报警 region_in_alarm 区域进入报警 region_out_alarm 区域离开报警 fast_move_alarm 快速移动报警 linger_alarm 徘徊检测报警 thirdparty_intelligent 第三方告警 face_alarm 人脸告警 abandon_alarm 物品遗留告警 removed_alarm 物品移走告警 electric_bicycle_alarm 电瓶车检测告警 people_leave_station_alarm 人员离岗告警 lift_electric_alarm 电梯电瓶车告警_新 occlusion_alarm 遮挡告警 advance_time String 预录时间，取值范围[1,59] after_time String 延录时间，取值范围[1,59] 表5 TimeSection 参数 参数类型 描述 day_of_week Integer 日期：取值[1,7]（对应周一~周日） 最小值：1 最大值：7 start_time String 录像开始时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59] end_time String 录像结束时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59]

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "channel_id" : "0", "plans" : [ { "alarm_type" : "motion_detection", "advance_time" : 30, "after_time" : 15 } ], "all_day" : false, "time_sections" : [ { "day_of_week" : 1, "start_time" : "00:02:00", "end_time" : "00:05:00" } ] }

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-alarm-plan 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

基本消息结构体 推送消息给企业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 设备异常消息，包含设备/通道上下线告警，通道名称修改，以及设备升级失败 设备解绑消息： device_unbind 设备解绑和套餐解绑的消息 设备智能数据消息： target_data 智能业务中的目标及目标整体业务 third_data 第三方智能业务，目前是提供整个数据包，使用方需自行解析。订阅时要和第三方智能告警数据区分开 vehicle_data 智能业务中的机非人业务 head_shoulder_data 智能业务中的头肩业务 behavior_analysis_data 智能业务中的行为分析与人车物分离 micro_checkpoint_data 智能业务中的微卡口业务 data Object 可能为空 智能告警信息： 当 message_type 不同时，data 格式不同，可参考message_type里各种类型的介绍； 当智能类型算法升级时，可能会在推送的结构体里添加新字段； test Boolean 不为空 当test字段为true时，表示这是配置回调URL时测试是否可访问的消息，被调用方需要返回响应码为200。注意，此时message_type和data字段不传。 当test字段为false时，表示这是一条推送消息，message_type和data字段正常传入。 父主题： 告警推送消息体结构

功能介绍 设备智能数据：设备安装相关算法后，在相应场景触发时，设备推送的算法结果消息。客户可根据算法结果实现自己的业务。 设备智能数据包含多种业务，每种业务的消息结构体都有差异，以下章节会对不同业务的消息结构体进行讲解。 设备智能数据消息体的message_type值为以下枚举值： target_data 智能业务中的目标及目标整体业务 third_data 第三方智能业务，目前是提供整个数据包，使用方需自行解析。订阅时需要和第三方智能告警数据区分开，一个是第三方TLV智能数据，一个是第三方智能告警 vehicle_data 智能业务中的机非人业务 head_shoulder_data 智能业务中的头肩业务 behavior_analysis_data 智能业务中的行为分析与人车物分离 micro_checkpoint_data 智能业务中的微卡口业务 备注：随着设备算法的升级可能会有出现文档中未描述的字段