华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_username String sip服务器用户名 sip_server_id String SIP服务器ID sip_server_domain String SIP服务器域 sip_server_host String SIP服务器地址 sip_server_port String SIP服务器端口 device_id String 设备ID：由数字组成，长度为20个字符长度

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "device_username" : "admin", "sip_server_id" : "3402000000***", "sip_server_domain" : "3402***", "sip_server_host" : "123.123.*.*", "sip_server_port" : 5060 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channels 是 Array of SetChannelRecordAlarmPlanReq objects 设置通道录像计划请求体 表4 SetChannelRecordAlarmPlanReq 参数 是否必选 参数类型 描述 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 码流类型（目前定为主码流，不用传，为后续需求留用） plans 是 Array of SetChannelRecordAlarmPlan objects 录像计划：列表长度范围[1,21] all_day 否 Boolean 是否全程录像：枚举类型，默认为false，如果为true，time_sections省略（不进行校验） 枚举值： true 是 false 否 time_sections 否 Array of TimeSection objects 通道录像计划时间段，取值范围[1,+∞)。如果all_day字段为空或为false，则字段必填 表5 SetChannelRecordAlarmPlan 参数 是否必选 参数类型 描述 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 是 Integer 预录时间，取值范围[1,59] after_time 是 Integer 延录时间，取值范围[1,59]。advance_time和after_time相加要不超过60s。 表6 TimeSection 参数 是否必选 参数类型 描述 day_of_week 是 Integer 日期：取值范围[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 表7 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 channels Array of ChannelResult objects 通道结果 表8 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 结果信息 表9 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

状态码 返回的状态码参考如下表所示： 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 Gateway Timeout 网关超时。 父主题： 附录

URI GET /v1/{user_id}/statistics/people 表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页面上获取 end_date 否 String 结束时间：日期格式为yyyyMMdd type为DAY或者YEAR时不用填写 type为WEEK或者MONTH时不填默认取start_date值 type为CUSTOMIZE时必填 start_date 是 String 开始时间：日期格式为yyyyMMdd type为DAY时，查询start_date当天人流信息 type为WEEK时，查询start_date当周人流信息 type为MONTH时，查询start_date当月人流信息 type为YEAR时，查询start_date当年人流信息 type 是 String 报表类型：枚举类型 枚举值： DAY 日统计 WEEK 周统计，需注意的是，如果start_date和end_date的日期跨度大于等于7天，会以MONTH 模式处理和返回数据 MONTH 月统计，需注意的是，如果start_date和end_date的日期跨度小于7天，会以WEEK 模式处理和返回数据 YEAR 年统计 CUSTOMIZE 自定义统计，预留，暂不使用

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 in Array of integers 进入人数列表 type是DAY时返回是当天24小时的人流流入统计数据 type是WEEK时返回是当周7天的人流流入统计数据 type是MONTH时返回是当月天数的人流流入统计数据 type是YEAR时返回是当年12个月的人流流入统计数据 out Array of integers 离开人数列表 type是DAY时返回是当天24小时的人流流出统计数据 type是WEEK时返回是当周7天的人流流出统计数据 type是MONTH时返回是当月天数的人流流出统计数据 type是YEAR时返回是当年12个月的人流流出统计数据

设备能力集 设备能力集 释义 ptz 云台控制能力 talk 对讲能力 localstorage 本地存储能力 flowstatis 客流统计能力 intelligent 智能分析能力 cloudstorage 云端录像能力 alarmvoice 报警声音能力 brotate 画面旋转能力 mediaencryptgcm 媒体加密算法能力 soundlightalarm 声光告警能力 algorithm 算法能力 reportupgrade 升级状态上报能力 logcollect 日志采集能力 audiovideoswitch 音视频切换能力 sdcardformat SD卡格式化能力 lightcontrol 指示灯开关能力 wifiinfo 网络配置信息能力 supplement 补光灯能力 certdelive 证书下发能力 batch_upgrade 批量更新能力 ptzspin 云台转动能力 zoom 缩放能力 autofocus 自动自动聚焦能力 volumnset 音量调节能力 reset 远程重置能力 maskmode 隐私遮蔽能力 motionflow 移动追踪能力 iris 云台-光圈能力 preset 云台-预置位能力 cruise 云台-巡航 securitykey SDC密码设置能力 tlvframe tlv显示框能力 alarmsound 声音警戒能力-有声光警戒能力此能力不显示 alarmlight 灯光警戒能力-有声光警戒能力此能力不显示 microphone 拾音器能力 devnormalrecord 设备前端录像支持连续录像能力 abilityauth 支持目标识别和特征协同功能 ptz_3d_locate 3d云台控制能力 父主题： 附录

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID：设备唯一标识符 targets Array of TargetVo objects 目标信息列表（SDC不返回图片） 表5 TargetVo 参数 参数类型 描述 target_id String 目标ID：目标标识符 name String 姓名 gender String 性别 age Integer 年龄 country String 国家 nation String 民族 native String 籍贯 occupation String 职业 organization String 组织名称 work_no String 工号或身份证号 phone String 电话 email String email domicile String 居住地 remark String 备注 eigen_value String 图片特征值 jpg String 图片内容：经过base64编码 start_time String 开始时间 end_time String 结束时间 external_target_id String 用户传入的目标ID：用户自定义的，在添加目标的时候由客户填入

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "targets" : [ { "name" : "mark", "gender" : "male", "age" : 24, "country" : "中国", "nation" : "汉", "native" : "杭州", "occupation" : "工人", "work_no" : "124****77", "phone" : "15********61", "email" : "1*********@qq.com", "domicile" : "杭州", "remark" : "无", "jpegBase64" : "/9j/4AAQSkZJRgABAQAAAQABAAD...", "target_id" : "2", "external_target_id" : "1234567890123***" } ] }

URI GET /v1/{user_id}/targets 表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 DELETE /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track 表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值为device_status。 表1 message_type为device_status时，data结构体如下： 字段名 类型 是否可为空 说明 method String 不为空 设备状态变更方法。 枚举值 logout 设备离线 login 设备上线 channel_state_notice 通道离线/上线（根据channel_state字段来区分） channel_name_notice 通道名称变更 upgrade_result 设备升级结果上报 offline_reason_notice 离线原因上报 param Param object 不为空 异常设备数据 表2 Param 字段名 类型 说明 device_id String 设备ID device_name String 设备名称 channel_id String 通道ID time String 设备告警时间 video_channel VideoChannel object 设备视频通道信息，数组对象 onine_time Int 上次在线时长：单位为秒/s last_login_time String 上次上线时间 alarm_uuid String 告警UUID：告警唯一标识，当method为设备升级失败/成功时，可通过该字段去查询设备升级失败/成功的详细信息。 overall_upgrade_status String 设备升级状态 device_type String 设备类型 offline_reason_type String 设备离线原因 枚举值： NORMAL 正常离线，例如重启或者掉电 NETWORK 网络异常离线 qos Float64 网络质量 time_delay Float64 时延 packet_loss_rate Float64 丢包率 push_time String 上报时间 表3 VideoChannel 字段名 类型 说明 channel_id String 通道ID channel_name String 通道名称 channel_state Int 通道状态，0：通道离线，1：通道上线 channel_ability String 视频通道能力。取值为 [ptz、talk、intelligent、soundlightalarm、algorithm] 中的零或多种，分别代表 [云台，对讲，智能分析，声光警戒，长尾算法] device_type String 视频通道的设备类型 manufacture String 通道接入设备的通道厂商 firmware String 通道接入设备的固件版本 model String 通道接入设备的型号 status_list Array of UpgradeStatusList objects 升级状态，如果method不是upgrade_result，该字段为null alarm_uuid String 告警UUID：告警唯一标识，当method为设备升级失败/成功时，可通过该字段去查询设备升级失败/成功的详细信息 表4 UpgradeStatusList 字段名 类型 说明 file_type Int 文件类型 枚举值： 0 基础软件包 1 目标和目标整体检测算法 2 目标识别算法包 4 违停检测算法包 8 机非人算法包 16 海外车牌检测算法包 32 场景自适应算法包 33 人群密度/排队长度算法包 64 三方APP包 65 4G软件包 66 D芯片升级包 67 D芯片算法包 68 周界算法包 69 星图算法包 70 星图1+2人像算法包 71 复杂行为算法包 75 热成像行为分析算法包 80 电梯电瓶车算法包 81 全结构化算法包 82 行为分析算法包 83 行为分析算法包，备注：82和83均为行为分析算法包 84 目标检测算法包 85 目标识别算法包 file_name String 文件名称：文件的名称，例如XXXXX.bin文件 package_name String 升级包名称：该升级文件所属的类型名，该名称与文件类型相对应，例如基础升级包、目标和目标整体检测算法， status String 升级状态 枚举值： preparing 准备中 unstart 未开始 starting 开始中 downloading 下载固件中 upgrading 升级固件中 success 升级成功 failure 升级失败 not_required 无需升级 示例一、设备上线 { "message_id": 1676292308043441909, "message_type": "device_status", "data": { "method": "login", "param": { "device_id": "219123456CYP***", "device_name": "MicroEdge", "channel_id": "", "time": "2023-02-13T20:43:47+08:00", "video_channel": [ { "channel_id": "7", "channel_name": "SDC", "channel_state": 1, "channel_ability": [ "talk", "intelligent", "soundlightalarm", "sdcardformat", "alarmsound", "abilityauth" ], "device_type": "IPC-CONCH", "manufacture": "huawei", "firmware": "SDC 10.0.RC11.SPC100", "model": "D3250-10-SIU", "status_list": null, "alarm_uuid": "" } ], "overall_upgrade_status": "", "device_type": "MEdge", "offline_reason_type": "", "qos": 0, "time_delay": 0, "packet_loss_rate": 0, "push_time": "2023-02-13 20:45:07" } }, "test": false } 示例二、设备离线 { "message_id": 1676293195851991937, "message_type": "device_status", "data": { "method": "logout", "param": { "device_id": "021123456MKR***", "device_name": "HoloSens SDC", "channel_id": "", "time": "2023-02-13T20:59:55+08:00", "video_channel": null, "online_time": 1077, "last_login_time": "2023-02-13 20:41:58", "alarm_uuid": "021RMK2202091846_device_offline_2023-02-13T20:59:55+08:00", "overall_upgrade_status": "", "device_type": "IPC-BOX", "offline_reason_type": "TMOUT", "qos": 0, "time_delay": 0, "packet_loss_rate": 0, "push_time": "2023-02-13 20:59:55" } }, "test": false } 示例三、设备通道离线 { "message_id": 1676294530831471492, "message_type": "device_status", "data": { "method": "channel_state_notice", "param": { "device_id": "219123456CYP***", "device_name": "FX_3.2.9.9_B016", "channel_id": "", "time": "2023-02-13T21:17:09+08:00", "video_channel": [ { "channel_id": "14", "channel_name": "${time@sys: YYYY-MM-DD}", "channel_state": 0, "channel_ability": [], "device_type": "IPC-BOX", "manufacture": "huawei", "firmware": "SDC 8.0.T2002", "model": "M2120-10-EI", "status_list": null, "alarm_uuid": "219123456CYP***_14_channel_offline_2023-02-13T21:17:09+08:00" } ], "overall_upgrade_status": "", "device_type": "", "offline_reason_type": "", "qos": 0, "time_delay": 0, "packet_loss_rate": 0, "push_time": "2023-02-13 21:22:07" } }, "test": false }

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

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

请求参数 表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 失效

响应示例 状态码： 200 OK 示例 1 { "pic_url" : "// 当 storage 字段为 false 时，此字段为空串", "pic_data" : "AAAAgAAAAAAAAAAAAAAAgAAAAd+/G0N4rYLasJ08oixRKANqyPxtwopjAcfLZ4vrF3LjwAAAAAAAAAAAAAAsIovJNbDeBeddTigN037AAiOm67Mrvka1Ht8LGT2S8FDAySkfqvCnq+CS5BmInek3OfrSDIQDy+TUImvmwYXjpj3FkYIU+L0GkGD7C6r73YxoZ2ocChqpARrXIzlp/zKi4DpzQ47Ese4IX2zkrLgehpMhE98" } 示例 2 { "pic_url" : "http://api-ivm.myhuaweicloud.com/v1/holo/219123456CYP***_0_210/static", "pic_data" : "// 当 storage 字段为 true 时，此字段为空串" } 示例2中获取到的pic_url的请求示例如下 请求 http://api-ivm.myhuaweicloud.com/v1/holo/219123456CYP***_0_210/static Access-Token: xxx 响应格式1: { "pic_data": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234" // base64编码的图片 } 响应格式2: 二进制编码的图片内容

URI GET /v1/{user_id}/devices/snap 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 storage 是 String 是否云存储标识。 枚举值： true 当需要云存储时，接口返回图片的下载URL； false 无需存储时，返回图片base64编码数据。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 录像文件总数量 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] records Array of ListDeviceRecordFilesResp objects 录像列表 表5 ListDeviceRecordFilesResp 参数 参数类型 描述 record_id String 录像ID：长度范围[1,32]，仅云端回放列表返回 record_name String 录像文件名称：长度范围[1,32] record_type String 录像类型：枚举类型 枚举值： NORMAL_RECORD 全量： 录像计划产生的录像 MOTION_RECORD 动检： 移动侦测产生的录像 ALRAM_RECORD 告警： 智能分析，目标分析等告警输入产生的录像 storage_state Integer 该接口返回参数新增storage_state（存储状态）枚举类型 枚举值 0 热备 标准存储 1 归档 2 回热中 归档（恢复中） 3 冷备 标准存储 record_size Integer 录像文件大小：单位（字节），仅云端回放列表返回 start_time String 录像开始时间：格式：yyyy-MM-dd HH:mm:ss end_time String 录像结束时间：格式：yyyy-MM-dd HH:mm:ss alarm_rec_type Array of string 告警录像类型：枚举类型，非告警录像值为空（null）

响应示例 状态码： 200 查询设备录像列表响应 { "total": 6, "device_id": "219123456CYP***", "channel_id": "0", "records": [ { "record_id": "12346556", "record_name": "_0_0_.rf", "record_type": "NORMAL_RECORD", "storage_state": 0, "record_size": 340017, "start_time": "2023-03-20 09:30:00", "end_time": "2023-03-20 09:44:39", "alarm_rec_type": [] }, { "record_id": "12346557", "record_name": "_0_1_.rf", "record_type": "NORMAL_RECORD", "storage_state": 0, "record_size": 340017, "start_time": "2023-03-20 09:46:41", "end_time": "2023-03-20 10:56:50", "alarm_rec_type": [] } ] }

URI GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/records 表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参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间：格式如：yyyy-MM-dd HHmmss end_time 是 String 结束时间：格式如：yyyy-MM-dd HHmmss record_position 是 String 录像位置，枚举类型 枚举值： CLOUD 云端录像 DEVICE 前端录像 record_type 否 String 录像类型：枚举类型，仅针对查询云端录像，不填则默认默认值为 ALL_RECORD 枚举值： ALL_RECORD 所有录像 NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像 limit 否 String 单页数量：取值范围[1,1000]，不填写时默认值为 10 offset 否 String 偏移量：offset为0时表示查询第一页的数据，取值范围[0,1000000]，不填写时默认值为 0 alarm_rec_type 否 String 告警录像种类（非告警录像值为null）

请求示例 查询前端的录像列表 GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/records?start_time=2023-03-20 09:30:00&end_time=2023-03-20 19:30:00&limit=2&record_type=NORMAL_RECORD&record_position=CLOUD

响应示例 状态码： 200 OK { "total" : 1, "device_id" : "952352LWXT***", "channel_id" : "0", "records" : [ { "record_id" : "1000000", "start_time" : "2020-06-12 17:31:00", "end_time" : "2020-06-13 12:50:00", "record_name" : "录像1", "record_size" : 1024, "record_type" : "NORMAL_RECORD" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 录像列表总数 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] records Array of Record objects 录像列表信息 表5 Record 参数 参数类型 描述 record_id String 录像ID：长度范围[1,32] record_name String 录像名称：长度范围[1,32] record_type String 录像类型：枚举类型 枚举值： NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像 record_size Integer 录像文件大小：单位（字节） alarm_rec_type String 告警录像类型：枚举类型，非告警录像值为空（null） start_time String 录像开始时间：格式如：yyyy-MM-dd HH:mm:ss，2020-06-12 17:31:00 end_time String 录像结束时间：格式如：yyyy-MM-dd HH:mm:ss，2020-06-12 17:31:00

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cloud-records 表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参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 end_time 是 String 结束时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 limit 否 Integer 单页数量：取值范围[1,1000]，不填写时默认值为 10 offset 否 Integer 偏移量：offset为0时表示查询第一页的数据，取值范围[0,1000000]，不填写时默认为 0 record_type 否 String 录像类型：枚举类型，不填则默认包含以下两种录像类型 枚举值： NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像

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

响应示例 状态码： 200 OK { "result" : [ { "enterprise_id" : "1230488562***", "device_org_id" : "1357924680***", "device_org_name" : "研发", "parent_id" : "1234567890***", "device_org_level" : 2, "is_leaf" : 0, "is_result" : 1, "camera_count" : 0, "camera_online_count" : 0, "children" : [ { "children" : [ ], "enterprise_id" : "1230488562***", "device_org_id" : "1357924680***", "device_org_name" : "Name", "parent_id" : "1234567890***", "device_org_level" : 2, "is_leaf" : 1, "is_result" : 1, "camera_count" : 0, "camera_online_count" : 0 } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Array of QueryDeviceOrgTreeVo objects 响应信息 表5 QueryDeviceOrgTreeVo 参数 参数类型 描述 enterprise_id String 企业ID，企业唯一标识符 device_org_id String 设备组织ID device_org_name String 设备组织名称 parent_id String 上级设备组织ID device_org_level Integer 设备组织级别，第一级子节点数值为1，第二级为2，以此类推 is_leaf Integer 是否是叶子节点：枚举类型 枚举值： 1 叶子节点，没有子级设备组织 0 非叶子节点，有子级设备组织 is_result Integer 是否是查询结果 camera_count Integer 设备数量 camera_online_count Integer 在线设备数量 children Array of query_device_org_tree_children objects 子组织信息 表6 query_device_org_tree_children 参数 参数类型 描述 device_org_id String 设备组织ID device_org_level Integer 设备组织级别，第一级子节点数值为1，第二级为2，以此类推 device_org_name String 设备组织名称 enterprise_id Integer 企业ID，企业唯一标识 is_leaf Integer 是否是叶子节点：枚举类型 枚举值： 1 叶子节点，下没有子级设备组织 0 非叶子节点，下有子级设备组织 is_result Integer 是否是查询结果 parent_id String 上级设备组织ID camera_count Integer 设备数量 camera_online_count Integer 在线设备数量 children Array of query_device_org_tree_children objects 子组织信息

URI GET /v1/{user_id}/device-orgs/tree 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50]

基本消息结构体 推送消息给企业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字段正常传入。 父主题： 告警推送消息体结构