华为云用户手册

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章节

响应参数 状态码： 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

功能介绍 云台控制，支持好望、国标设备云台八向转动、点动，变焦，光圈，聚焦等能力 点动模式：只要调用一次云台移动相关命令（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），不需要调用STOP命令后会自动停止 转动模式：调用云台移动相关命令后（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），设备会一直不停转动，一直到发送STOP命令后才会停止 因华为SDC本身限制，云台控制指令短时间内无法接收过多，否则导致崩溃或连续转动，连续命令触发间隔应≥300ms

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken，从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 direction 是 String 方向：枚举类型 枚举值： LEFT 左转 UP 上转 RIGHT 右转 DOWN 下转 UPPER_LEFT 左上转动（设备10.0以上版本支持） UPPER_RIGHT 右上转动（设备10.0以上版本支持） LOWER_LEFT 左下转动（设备10.0以上版本支持） LOWER_RIGHT 右下转动（设备10.0以上版本支持） STOP 停止八向转动及变焦，其中停止变焦不支持直连摄像机（除E系列） IN 变焦放大 OUT 变焦缩小 ZOOM_STOP 变焦停止，所有云台设备都支持 FOCUS_FAR 聚焦变远 FOCUS_NEAR 聚焦变近 AUTO_FOCUS 自动聚焦（设备10.0以上版本支持） IRIS_OPEN 光圈变大 IRIS_CLOSE 光圈变小 FI_STOP 光圈和聚焦停止 control_lock 是 String 设备操作token不能为空（从获取云台控制权接口获取），token获取后只要进行云台控制操作就能够进行续签，不需要一直获取云台控制权 speed 否 Integer 速度，取值范围[1,10]，非必填，默认是10 mode 否 String 点动模式：默认方式，注：好望摄像机以华为协议接入的时候，变焦和聚焦时，需手动单击停止，否则会一直放大或者缩小。以onvif协议接入时，变焦和聚焦后则会自动停止 转动模式：枚举类型，非必填，国标设备只能使用转动模式，直连摄像机（除E系列）聚焦和变焦功能只能使用转动模式 枚举值： POINT 点动模式 NON_POINT 转动模式 heartbeat_mode 否 String 心跳模式：枚举类型，默认为关，只有E系列摄像机有用，心跳模式能够帮助E系列摄像机一直维持转动 枚举值： OPEN 开启心跳模式 CLOSE 关闭心跳模式

URI POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/ptz/angle-spin 表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 OK { "p2p_connections" : [ { "device_id" : "D123", "token" : "XSab786654", "p2p_nodes" : [ { "address_type" : "IPV4", "address" : [ "123.123.*.*", "lingwai123.123.*.*" ], "tcp_port" : 0, "udp_port" : 7050, "node_type" : "BETTER" } ], "device_state" : "ONLINE", "result" : { "code" : "IVM.0", "msg" : "Success" } }, { "device_id" : "D124", "token" : "XSab786654", "p2p_nodes" : [ { "address_type" : "IPV4", "address" : [ "123.123.*.*", "123.123.*.*" ], "tcp_port" : 0, "udp_port" : 7050, "node_type" : "BETTER" } ], "device_state" : "ONLINE", "result" : { "code" : "IVM.0", "msg" : "Success" } } ], "live_urls" : [ { "device_id" : "D123", "channel_id" : "0", "live_url" : "jvmp://123.123.*.*:***/live/2102412469", "result" : { "code" : "IVM.0", "msg" : "Success" } }, { "device_id" : "D124", "channel_id" : "1", "live_url" : "jvmp://123.123.*.*:***/live/2102412469", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }

请求示例 发起P2P实况连接信息 POST /v1/2562572829***/devices/channels/p2p-connect/live { "channels": [ { "device_id": "952352LWXT***", "channel_id": "123", "stream_type": "PRIMARY_STREAM" }, { "device_id": "952352LWXT***", "channel_id": "123", "stream_type": "SECONDARY_STREAM_1" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 fail_num Integer 获取设备url失败的数量 p2p_connections Array of P2PDevicesResp objects P2P信息列表 live_urls Array of getLiveURLChannelsResp objects 云转发地址列表 request_id String 该请求的id 表6 P2PDevicesResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] p2p_nodes Array of P2PMTSListResp objects p2p连接可用节点 device_state String 在线状态：枚举类型 枚举值： OFFLINE 离线 ONLINE 在线 token String P2P请求Token result Result object 错误信息 表7 P2PMTSListResp 参数 参数类型 描述 address Array of strings 媒体转发服务地址： 协议头在SDK封装 ，根据address_type决定地址类型 DOMAIN: www.huawei.com IPV4: 123.123.123.123 IPV6: fe80::f816:3eff:feed:5821 address_type String 地址类型：枚举类型 DOMAIN 域地址 IPV4 IPv4地址 IPV6 IPv6地址 node_type String 节点类型：枚举类型 枚举值： COMMON 普通：普通的三线（移动，联通，电线）服务器，与地域有关，服务器由运营商托管，网络通信质量低 BETTER 优质：全网通服务器（华为云服务器等），网络通信质量高 tcp_port Integer TCP端口：默认值为 0 备注：未使用0端口，tcp_port只作为兼容字段保留 udp_port Integer UDP端口：默认值为 7050 表8 getLiveURLChannelsResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] live_url String 媒体实况播放地址 result Result object 错误信息 表9 Result 参数 参数类型 描述 code String 错误编码，请参见错误码 msg String 错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channels 是 Array of P2PChannelsLiveParam objects 请求信息 expire_time 否 Integer 自定义Url过期时间：时间范围[30, 86400]，不填写时默认值为 30（单位/秒） 备注：仅对live_urls中的live_url有效 use_times 否 Integer 自定义Url使用次数：枚举类型，不填写时默认值为 0 备注：仅对live_urls中的live_url有效 枚举值： 0 使用一次 1 有效时间内任意使用 表4 P2PChannelsLiveParam 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 备注：国标协议不支持P2P连接 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] stream_type 是 String 码流类型：枚举类型 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 preset_name 是 String 预置位名称：数字、中文、英文、空格、-、_，.，长度范围[1,128] index 否 Integer 预置位序号：直连设备必传，非直连场景不传。取值范围[1,512]

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

消息结构体介绍 表1 message_type为third_data时，data结构体如下： 字段名 类型 说明 device_id String 设备ID，正常情况下不为空，必传 channel_id String 通道ID，正常情况下不为空，必传 report_time String 上报告警时间。示例：2020-09-26T14:28:00+08:00 data_id String 数据ID：正常情况下不为空，必传。可用于查询智能图片数据，参考链接：智能图片下载 tlv_data String 第三方 tlv 数据包，base64编码的字符串，该数据较长需要准备好足够的空间 示例一、三方TLV数据示例 { "message_id": 1676253463557926634, "message_type": "third_data", "data": { "device_id": "219123456CYP***", "channel_id": "1", "report_time": "2023-02-13T09:57:41+08:00", "tlv_data": "TUVUQQAAAAABAAAgEAAAAGJlaGF2aW9yQW5hbHlzZQACAAAgBQAAAElUR1QABwAACQgAAABAAAAAAAAAAGEA" }, "test": false }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 abilities Array of StreamAbilityItem objects 码流能力列表 channel_no Integer 视频通道ID is_support_corridor_mode Boolean 是否支持走廊模式 is_support_water_mark Boolean 是否支持水印，取值范围：true – 支持；false – 不支持 mirror_mode MirrorMode object 镜像模式 variable_bit_rate VariableBitRate object 动态码率 variable_frame VariableFrame object 动态帧率 h264_info EncodeInfo object H264编码信息 h265_info EncodeInfo object H265编码信息 mjpeg_info EncodeInfo object MJPEG编码信息 digital_zoom_info DigitalZoomInfo object 数字变倍信息 roi_info ROIInfo object ROI（感兴趣区域）信息 vo_info VOInfo object VO模拟输出能力 osd_info OSDInfo object OSD信息 is_hide_sub_stream_for_main_mjpeg Boolean 主码流MJPEG开启时是否隐藏子码流 表4 StreamAbilityItem 参数 参数类型 描述 stream_count Integer 码流数量 max_frame_rate Integer 最大帧率 stream_info Array of StreamInfo objects 码流信息 表5 StreamInfo 参数 参数类型 描述 stream_type Integer 码流类型：枚举类型 枚举值： 0 主码流， 1 子码流1 2 子码流2 encode_mode Array of EncodeMode objects 编码信息列表 support_crop Boolean 是否支持裁剪：枚举类型 枚举值： false 不支持 true 支持 support_eptz Boolean 是否支持电子云台：枚举类型 枚举值： false 不支持 true 支持 表6 EncodeMode 参数 参数类型 描述 type String 编码类型：枚举类型 枚举值： H.264 H.265 MJPEG resolution Array of Resolution objects 分辨率列表 表7 Resolution 参数 参数类型 描述 type String 分辨率长和宽为数字，通过*分隔 frame_rate Array of integers 帧率列表 bit_rate BitRate object 该分辨率对应的码率信息 表8 BitRate 参数 参数类型 描述 support Boolean 该分辨率对应的是否支持码率配置* begin Integer 该分辨率对应的码率最小值* end Integer 该分辨率对应的码率最大值* default Integer 该分辨率对应的码率默认值* 表9 MirrorMode 参数 参数类型 描述 support Boolean 是否支持镜像模式：枚举类型 枚举值： false 关闭 true 开启 type Array of integers 镜像类型：枚举类型 枚举值： 0 不开启镜像 1 水平镜像 2 垂直镜像 3 水平垂直镜像 表10 VariableBitRate 参数 参数类型 描述 support Boolean 是否支持动态码率：枚举类型 枚举值： false 关闭 true 开启 表11 VariableFrame 参数 参数类型 描述 support Boolean 是否支持动态帧率：枚举类型 枚举值： false 关闭 true 开启 表12 EncodeInfo 参数 参数类型 描述 intelligence Intelligence object 智能编码信息 is_support_slice Boolean 是否支持多Slice编码 is_support_layered_encoding Boolean 是否支持分层编码 profile_list ProfileList object 编码复杂度类型 i_frame_interval IFrameInterval object I帧间隔 bit_rate_info BitRateInfo object 码率信息 jpeg_quality JpegQuality object jpeg质量 表13 Intelligence 参数 参数类型 描述 support Boolean 是否支持智能编：枚举类型 枚举值： false 关闭 true 开启 type Array of integers 支持智能编码类型 表14 ProfileList 参数 参数类型 描述 support Boolean 是否支持编码复杂度类型：枚举类型 枚举值： false 关闭 true 开启 type Array of integers 枚举类型 H264编码枚举值： 0 High profile， 1 Main profile 2 Base profile H264编码枚举值： 0 Main profile 表15 IFrameInterval 参数 参数类型 描述 support Boolean 是否支持I帧间隔：枚举类型 枚举值： false 关闭 true 开启 begin Integer I帧间隔最小值 end Integer I帧间隔最大值 表16 BitRateInfo 参数 参数类型 描述 support Boolean 是否支持：枚举类型 枚举值： false 关闭 true 开启 bit_rate_type Array of BitRateType objects 码率类型：枚举类型 枚举值： 0 定码率 1 变码率 表17 JpegQuality 参数 参数类型 描述 begin Integer jpeg质量最小值：1 end Integer jpeg质量最大值：99 表18 BitRateType 参数 参数类型 描述 type Integer 码率类型 bit_rate_mode Array of integers 定码率类型：枚举类型 枚举值： 1 帧率优先 2 图像质量优先 pic_quality Array of integers 变码率图像质量：枚举类型 枚举值： 1 最好 2 次好 3 较好 4 一般 5 较差 6 差 表19 DigitalZoomInfo 参数 参数类型 描述 max_zoom Integer 数字变倍支持的最大倍率 support Boolean 是否支持数字变倍 表20 ROIInfo 参数 参数类型 描述 support Boolean 是否支持感兴趣区域编码：枚举类型 枚举值： false 关闭 true 开启 roi_quality ROIQuality object 感兴趣区域编码质量能力对象 表21 ROIQuality 参数 参数类型 描述 begin Integer 最小值 end Integer 最大值 表22 VOInfo 参数 参数类型 描述 param VOInfoParam object 参数 support Boolean 是否支持模拟输出能力：枚举类型 枚举值： false 关闭 true 开启 表23 VOInfoParam 参数 参数类型 描述 channel_no String 通道号 表24 OSDInfo 参数 参数类型 描述 support Boolean 是否支持OSD：枚举类型 枚举值： false 关闭 true 开启

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

功能介绍 行为分析与人车物分离业务：对人车物行为进行分析生成相应数据的智能场景。 行为分析与人车物分离业务消息体的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}/devices/{device_id}/channels/{channel_id}/targets/authorization 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 目前只支持好望设备，取值范围[-1,999]。通道id传-1时代表只查询设备本身，传通道id时查设备及通道。 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 callback_url String 支持http/https协议，最大长度为256常规字符 create_time String 创建时间 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数据，该消息的数据推送结构体微卡口数据推送结构体

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证token，从获取用户认证token接口获取 表3 请求Body参数 参数 是否必选 参数类型 描述 callback_url 是 String 要添加的URL，支持http和https协议，长度在256常规字符以内，不支持中文，长度范围[1,256] 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数据，该消息的数据推送结构体微卡口数据推送结构体 auth_key 否 string 鉴权密钥：给客户推送消息时，客户认证时使用，长度范围[6,18]，该字段为非必填字段，但建议客户填写，有助于提高可靠性。 认证方式如下： 当配置了auth_key后，回调方会根据 （回调地址+"|"+时间戳+"|"+auth_key）用sha256算法做数字摘要。 在回调时，通过HEAD参数 "X-Ivm-Signature" 传递摘要，"X-Ivm-Timestamp"传递时间戳。设置方通过计算sha256(回调地址+"|"+时间戳+"|"+auth_key)进行认证，可参考告警推送消息体结构

功能介绍 配置用户消息通知URL（增加或者更新用户消息通知URL）。 配置回调 URL 时将通过 HTTP/HTTPS 请求的方式发送一条测试请求给用户服务器，用户服务器需要处理行业视频管理服务的回调请求，并尽快进行应答。 注意事项： 回调的方向是行业视频管理服务向用户服务器发起 HTTP/HTTPS POST 请求，为了获得更高的安全性，推荐您使用 HTTPS 通道发送请求； 行业视频管理服务回调用户服务器的超时时间为 1 秒，且没有重试。如果回调超时，则配置失败。为确保回调成功率，用户服务器应当尽可能加快回调处理速度，例如先发送回调应答，然后再处理具体业务逻辑； 确保回调 URL 的 IP 和端口公网可达，以及防火墙策略不限制外网访问，接口应支持application/json格式的数据 回调请求成功后，确保应答报文中的 HTTP 返回码为 200。 配置回调 URL 时，云服务端会访问该地址是否可用。访问请求体格式为: { "message_id": 1614936351275468803, // int64 或 long 整型 "test": true // boolean 类型 } 注意，在配置好回调 URL，还需要给设备开通接入调阅服务和行业数据流服务后，才能接收到告警数据。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 failed_num Integer 请求失败数：取值范围[0，100] data Array of Data objects 响应信息 表5 Data 参数 参数类型 描述 data_id String 智能数据id urls Array of DownloadInfo objects 图片网络下载路径，该路径有效期为五分钟 result Result object 请求结果 表6 DownloadInfo 参数 参数类型 描述 type String 图片类型 TARGET业务： ALL 全部 BODY 人体图 BACKGROUND 背景图 TARGET 人脸图 VEHICLE业务： ALL：全部 VEHICLE 车辆图 BACKGROUND 背景图 PLATE 车辆图 url String 图片下载url 表7 Result 参数 参数类型 描述 code String 错误码 msg String 错误信息

请求示例 获取图片下载路径请求体 POST /v1/123456789*****/intelligence-data/pictures { "data_classification" : "VEHICLE", "type" : "VEHICLE", "data_ids" : [ "06cac6be36394e2a813088bf0c0cb31c", "32a0223a911b44468c376a61f2c4d8a7" ] }

响应示例 状态码： 200 OK { "failed_num" : "integer", "data" : [ { "data_id" : "string", "urls" : [ { "type" : "string", "url" : "string" } ], "result" : { "code" : "string", "msg" : "string" } } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证token，从获取用户认证token接口获取 表3 请求Body参数 参数 是否必选 参数类型 描述 data_classification 是 String 智能类型： 枚举值： TARGET 目标（通过订阅TARGET_DATA类型获取到的TLV数据，使用该参数获取图片URL） VEHICLE 车辆（通过订阅VEHICLE_DATA类型获取到的TLV数据，使用该参数获取图片URL） type 是 String 图片类型枚举值： TARGET业务： ALL 全部 BODY 人体图 BACKGROUND 背景图 TARGET 人脸图 VEHICLE业务： ALL：全部 VEHICLE 车辆图 BODY 人体图 BACKGROUND 背景图 PLATE 车牌图 data_ids 是 Array of strings 数据ID：从设备智能数据（TLV）消息体结构中查阅（仅支持TLV数据)，数组长度[1,100]

响应示例 状态码： 200 OK { "groups": [ { "name": "ssre2d", "enable": "CLOSE", "group_id": 2, "is_fixed": true, "is_hidden": false } ], "device_id": "952352LWXT***", "group_max_count": 128 }

URI GET /v1/{user_id}/target-groups 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK 表2 Query参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 groups Array of TargetGroup objects 目标库分组列表 device_id String 设备ID，设备唯一标识符 group_max_count String 最大目标库分组数量限制：-1表示不限制 表5 TargetGroup 参数 参数类型 描述 group_id Integer 目标库分组ID：目标库标识符 name String 目标库名称 enable String 目标库分组是否生效：枚举类型 IVS1800设备该字段不返回，IVS1800目标库均生效 枚举值： OPEN 生效 CLOSE 失效 is_fixed Boolean 是否可修改：true表示该目标库分组详情不可修改，false表示该目标库分组详情可以修改 is_hidden Boolean 是否隐藏：仅NVR有用，白名单返回的true，其他类型的目标库返回的是false

URI GET /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

请求示例 批量设置通道录像计划 PUT /v1/2562572829***/devices/channels/record-plan { "plans" : [ { "device_id" : "952352LWXT***", "channel_id" : "0", "all_day" : false, "time_sections" : [ { "day_of_week" : 1, "start_time" : "00:02:00", "end_time" : "00:05:00" }, { "day_of_week" : 1, "start_time" : "00:06:00", "end_time" : "00:08:00" }, { "day_of_week" : 2, "start_time" : "00:02:00", "end_time" : "00:05:00" } ] }, { "device_id" : "952352DJNR***", "channel_id" : "0", "all_day" : false, "time_sections" : [ { "day_of_week" : 1, "start_time" : "00:02:00", "end_time" : "00:05:00" } ] } ] }

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

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 channels Array of ChannelResult objects 通道结果 表7 ChannelResult 参数 参数类型 描述 device_id String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 result Result object 结果信息 表8 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息