请求示例 查询通道实况播放地址 POST /v1/2562572829***/devices/channels/cloud-live/url { "channels": [ { "device_id": "952352LWXT***", "channel_id": "0", "live_protocol": "HOLO", "stream_type": "PRIMARY_STREAM" }, { "forbid_audio":1, "device_id": "952352DJNR***", "channel_id": "0", "live_protocol": "HLS", "stream_type": "PRIMARY_STREAM" }, { "device_id": "952352DJNR***", "channel_id": "0", "live_protocol": "HLS_HTTPS", "stream_type": "PRIMARY_STREAM" }] }

响应示例 状态码： 200 OK { "fail_num": 0, "channels": [ { "device_id": "952352LWXT***", "channel_id": "0", "live_url": "jvmp://123.123.*.*:***/live/952352LWXT***?token=...", "result": { "code": "IVM.0", "msg": "Success" } }, { "device_id": "952352DJNR***", "channel_id": "0", "live_url": "http://123.123.*.*:***/live/live.m3u8?token=...&device_id=952352DJNR***&channel_id=0&stream_type=0&forbid_audio=1", "result": { "code": "IVM.0", "msg": "Success" } }, { "device_id": "952352DJNR***", "channel_id": "0", "live_url": "https://123.123.*.*:***/live/live.m3u8?token=...&device_id=952352DJNR***&channel_id=0&stream_type=0", "result": { "code": "IVM.0", "msg": "Success" } } ], "request_id": "0e3515f7-4c5e-497f-abb8-4541d6963dd2" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channels 是 Array of GetLiveURLChannelsParam objects 通道列表 expire_time 否 Integer 自定义Url过期时间：时间范围[30, 86400]，不传默认为 30（单位/秒） 备注：仅对channels中的live_url有效 use_times 否 Integer 自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP协议固定为 0 备注：仅对channels中的live_url有效 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP协议无效 表4 GetLiveURLChannelsParam 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 live_protocol 是 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型 枚举值： HOLO 好望协议 HLS 基于HTTP的HLS流媒体传输协议（该协议存在安全风险，建议优先使用其他协议） HLS_HTTPS 基于HTTPS的HLS流媒体传输协议 HTTP_FLV 基于HTTP的FLV媒体协议（该协议存在安全风险，建议优先使用其他协议） HTTPS_FLV 基于HTTPS的FLV媒体协议 RTSP RTSP流媒体传输协议（该协议存在安全风险，建议优先使用其他协议） stream_type 是 String 码流类型：枚举类型 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2 forbid_audio 否 Integer 禁用音频选项：不填写默认值为 0 备注：只针对HLS有效，推荐微信小程序端使用禁用音频选项 枚举值： 0 不禁用音频 1 禁用音频 trans_protocol 否 String 传输协议：枚举类型，不填写时默认值为 TCP，仅适用于gb28181，其它接入协议无效 枚举值： TCP TCP传输协议 UDP UDP传输协议

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 fail_num Integer 获取设备url失败的数量 channels Array of getLiveURLChannelsResp objects 响应信息 request_id String 该请求的记录id 表6 getLiveURLChannelsResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] live_url String 媒体实况播放地址：将此url输入播放地址栏开始播放 result Result object 错误信息 表7 Result 参数 参数类型 描述 code String 错误编码：请参见错误码 msg String 错误信息

智能数据（TLV）相关字段枚举值说明参考 表1 trecord_type 告警类型 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 0 移动侦测 16 中硬遗留检测 32 偏色诊断 48 逆行 1 遮挡检测 17 音频有无告警 33 停车侦测 49 异常车牌 2 目标检测 18 音频陡降告警 34 机非人 50 交通拥堵 3 3559目标检测 19 音频陡降告警 35 过线计数 51 倒车 4 3559目标识别 20 区域进入 36 微卡口 52 车辆黑名单设防 5 入侵检测 21 区域离开 37 ITS违章信息 53 车辆白名单设防 6 目标计数 22 快速移动 38 ITS存储图片 54 遮挡车牌 7 干扰检测 23 场景变更 39 人群密度 55 打架 8 干扰检测 24 自动跟踪 40 排队检测 56 攀爬 9 网络端口状态 25 虚焦检测 41 违停球 57 跌倒 10 中硬拌线检测 26 聚集侦测 42 交通拥堵告警 58 跑步 11 中硬入侵检测 27 抖动诊断 43 机非人_目标 59 火点告警 12 中硬徘徊检测 28 画面冻结诊断 44 违法停车 60 温控告警 13 中硬遗留检测 29 雪花噪声诊断 45 非占机 - - 14 中硬移走检测 30 条纹噪声诊断 46 机占非 - - 15 中硬干扰检测 31 亮度诊断 47 压线 - - 表2 rule_type 规则线类型 规则线类型枚举值 枚举值原型 释义 规则线类型枚举值 枚举值原型 释义 0 TRIPWIRE_RULE 拌线 13 MSL_AUTO_CALIB_RULE 枪球联动自动标定 1 WANDER_RULE 漂移 14 MSL_AUTO_CALIB_RULE_CLEAR 枪球联动自动标定清除 2 ABANDON_RULE 遗留 15 FIGHTING_RULE 打架 3 REMOVE_RULE 移走 16 CLIMBING_RULE 攀爬 4 INVASION_RULE 入侵 17 FALL_DOWN_RULE 跌倒 5 ENTER_RULE 进入 18 RUNNING_RULE 跑步 6 EXIT_RULE 退出 19 FIRE_DETECT_RULE 火点检测 7 FASTMOVE_RULE 快速移动 20 CALIB_RULE_RULE 定点 8 CARDETECTION_RULE 车辆检测 21 COMM_TLV_TEXT_RULE 通用TLV字体显示 9 HUMANCOUNT_RULE 人群计数 22 MOTORBIKE_DET_RULE 电瓶车告警 10 CROWDDENSITY_DETECT_RULE 人群密度 23 LEAVEDETECT_RULE 离岗检测 11 QUEUE_DETECT_RULE 排队检测 - - - 12 IBALL_DETECT_RULE 违停球检测 - - - 表3 plate_color 车牌颜色 车牌颜色枚举值 释义 车牌颜色枚举值 释义 1 蓝底白字 9 白底红字 2 黄底黑字 10 蓝底白字 3 白底黑字 11 白底蓝字 4 黑底白字 12 白底黄字 5 绿底白字或者绿底黑字 13 白底绿字 6 渐变绿底黑字 14 白底灰字 7 黄绿双拼底黑字 15 灰底黑字 8 红底白字 - - 表4 vehicle_type 机非人类型 机非人类型枚举值 释义 机非人类型枚举值 释义 1 轿车 22 中型SUV 2 货车 23 中大型SUV 3 面包车 24 大型SUV 4 客车 25 微型面包车 5 小货车 26 MPV 6 SUV 27 轿跑 7 中型客车 28 微卡 8 摩托车-非机动车 29 皮卡 9 行人 30 中卡 10 校车 31 轻卡 11 泥头车-渣土车 32 重卡 12 高危车 33 出租车 13 骑行人 34 油罐车 14 微型轿车 35 吊车 15 小型轿车 36 海外摩托车 16 紧凑型轿车 37 公交车 17 两厢轿车 38 自行车 18 三厢轿车 39 三轮车 19 轻客 40 电瓶车 20 小型SUV 512 全部 21 紧凑型SUV - - 表5 vehicle_color 车辆颜色 车辆颜色枚举值 释义 车辆颜色枚举值 释义 1 白色 8 棕色 2 灰色（银色） 9 黑色 3 黄色 10 紫色 4 粉色 11 桔色 5 红色 12 青色 6 绿色 13 金色 7 蓝色 14 银色 表6 car_pre_brand/car_pre_brand_index 车款类型 车款枚举值 释义 车款枚举值 释义 车款枚举值 释义 车款枚举值 释义 1 GMC 2 Jeep 3 MG 4 MINI 5 smart 6 一汽 7 三菱(东南) 8 三菱 9 上汽大通 10 东南 11 东风 12 东风小康 13 东风风度 14 东风风神 15 东风风神 16 中兴 17 中华 18 中顺 19 丰田 20 五十铃 21 五菱汽车 22 众泰 23 依维柯 24 保时捷 25 克莱斯勒 26 兰博基尼 27 凯迪拉克 28 别克 29 力帆 30 北京汽车 31 北汽制造 32 北汽威旺 33 华普 34 华泰 35 华泰（现代） 36 双环 37 双龙 38 吉利 39 启晨 40 哈飞 41 大众 42 大发 43 奇瑞 44 开瑞 45 奔驰 46 奥迪 47 威麟 48 宝马 49 宝骏 50 中通 51 北方 52 华西 53 友谊 54 四川现代 55 宇通 56 安凯 57 少林 58 扬子江 59 江淮 60 梅洛 61 福田 62 穗通 63 金旅 64 金龙 65 长安 66 青年 67 黄海 68 宾利 69 广汽传祺 70 广汽吉奥 71 悍马 72 捷豹 73 斯巴鲁 74 斯柯达 75 日产 76 昌河 77 本田 78 林肯 79 标志 80 欧宝 81 比亚迪 82 永源 83 汇众 84 江铃 85 沃尔沃 86 法拉利 87 海马 88 斯特拉 89 猎豹汽车 90 玛莎拉蒂 91 现代 92 现代或黄海 93 理念 94 瑞麒 95 福特 96 福迪 97 纳智捷 98 英菲尼迪 99 荣威 100 莲花 101 菲亚特 102 讴歌 103 三一重工 104 东风或者南郡或者大运 105 东风柳汽 106 中国重汽 107 五征或者飞碟 108 凯马 109 北京 110 北京威龙 111 北奔 112 北奔重卡 113 北汽 114 华棱 115 南郡或者东风 116 唐骏 117 大运 118 广汽田野 119 精工重卡 120 红岩 121 解放 122 跃进 123 金杯 124 陕汽 125 霸龙重卡 126 飞碟 127 起亚 128 路虎 129 道奇 130 铃木 131 长城 132 长安商用 133 陆风 134 雪佛兰 135 雪铁龙 136 雷克萨斯 137 雷诺 138 风驰 139 马自达 140 黄海（北京） 141 三轮车 142 五菱 143 华泰（现代） 144 吉利金球鹰 145 吉利帝豪 146 奔腾 147 广汽 148 猎豹 149 红旗 150 金杯或福田 151 重汽豪沃 152 北汽绅宝 153 广汽日野 154 黑豹 155 东风客车 156 哈弗 157 黄海客车 158 时代汽车 159 DS 160 欧曼 161 驭胜 162 成功汽车 163 北汽幻速 164 启辰 165 莲花汽车 166 东风风光 167 重汽王牌 168 联合卡车 169 衡山 170 福汽启腾 171 陕汽重卡 172 思铭 173 安源客车 174 申龙客车 175 中车时代 176 北汽新能源 177 齐鲁客车 178 南骏汽车 179 东风超车客车 180 奥驰汽车 181 庆铃 182 斯堪尼亚 183 重汽HOWO轻卡 184 九龙 185 搅拌车 186 厢式车 187 栏板车 188 其他 189 油罐车 190 大运重卡 191 上汽依维柯红岩 192 一汽通用 193 五洲龙客车 194 知豆 195 扬子江汽车 196 申沃客车 197 宝沃 198 汉腾汽车 199 潍柴英致 200 凯翼 201 SWM斯威汽车 202 野马汽车 203 华硕 204 观致 205 大运轻卡 206 一汽柳特 207 重汽豪瀚 208 重汽重汽汕德卡 209 重汽斯太尔 210 WEY 211 腾势 212 比速汽车 213 阿斯顿马丁 214 萨博 215 陕汽通家 216 康迪全球鹰 217 长安跨越 218 卡威 219 南京金龙 220 广客 221 皮卡 222 迈凯伦 223 校车 224 领克 225 缔途 226 劳斯莱斯 227 公共巴士 228 未知 229 吊车 230 阿尔法罗密欧 231 GMC - - 表7 plate_type 车牌类型 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 0 未知类型 17 新能源牌 120 香港车牌 153 阿根廷车牌 1 单层蓝牌 18 其他类型 130 巴西私家车牌 160 南非私家车牌 2 单层黑牌 19 教练车牌 131 巴西商用车牌 161 南非官方车牌 3 单层黄牌 20 民航车牌 132 巴西官方车牌 162 南非外交车牌 4 双层黄牌 22 应急车牌 133 巴西外交车牌 163 南非警车牌 5 白色警牌 23 非机动车双层蓝牌 134 巴西摩托车牌 164 南非军车牌 6 白色武警 24 使馆车牌 135 巴西车牌 165 南非摩托车牌 7 双层白色武警 25 挂车车牌 140 墨西哥私家车牌 166 南非车牌 8 单层军牌 26 摩托车黄牌 141 墨西哥公交车牌 170 加纳私家车牌 9 双层军牌 27 摩托车蓝牌 142 墨西哥出租车牌 171 加纳官方车牌 10 领馆车牌 100 印尼私家车牌 143 墨西哥卡车牌 172 加纳外交车牌 12 港牌 101 印尼公共交通车牌 144 墨西哥摩托车牌 173 加纳商用车牌 13 澳门牌 102 印尼使馆车牌 145 墨西哥车牌 174 加纳摩托车牌 14 农用车牌 拖拉机 103 印尼车牌 150 阿根廷私家车牌 175 加纳车牌 15 厂内牌 110 沙特私家车牌 151 阿根廷官方车牌 180 台湾车牌 16 个性化车牌 111 沙特公共交通车牌 152 阿根廷摩托车牌 - - 父主题： 附录

设备能力集 设备能力集 释义 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云台控制能力 父主题： 附录

调用准备 NVR在线并且有足够的硬盘空间（空间不足会导致无法获取名单库分组），硬盘空间可在NVR设备界面的“存储管理”中确认。 NVR下至少要有一个支持目标识别功能的SDC在线。 导入的目标base64图片数据不要超过40KB，以免图片过大导致导入失败。 接口调用前需确认好环境地址端口、URL、请求方式、请求参数字段与类型等信息。 NVR从8.1.RC1.B015版本开始就支持名单导入，SDC需要包含或能安装目标识别算法包的型号，如C2150、C2120等。

操作解析 将得到的热度值0~255平均划分成22等分（范围），每个范围对应一种ARGB颜色，得到彩色热度图图片。 热度值和颜色对应关系如下： 热度值 ARGB颜色 0~11 (0, 0, 0, 0) 12~23 (255, 0, 0, 255) 24~34 (255, 0, 51, 255) 35~46 (255, 0, 102, 255) 47~57 (255, 0, 153, 255) 58~69 (255, 0, 204, 255) 70~81 (255, 0, 255, 255) 82~92 (255, 0, 255, 204) 93~104 (255, 0, 255, 153) 105~115 (255, 0, 255, 102) 116~127 (255, 0, 255, 51) 128~139 (255, 0, 255, 0) 140~150 (255, 51, 255, 0) 151~162 (255, 102, 255, 0) 163~173 (255, 153, 255, 0) 174~185 (255, 204, 255, 0) 186~197 (255, 255, 255, 0) 198~208 (255, 255, 204, 0) 209~220 (255, 255, 153, 0) 221~231 (255, 255, 102, 0) 232~243 (255, 255, 51, 0) 244~255 (255, 255, 0, 0)

状态码 返回的状态码参考如下表所示： 表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 网关超时。 父主题： 附录

请求示例 通过版本查询设备能力集 POST /v1/2562572829***/devices/ability { "versions" : [ { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC11" }, { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC12" } ], "need_specification" : true, "ability" : [ "ptz", "soundlightalarm" ] }

响应示例 状态码： 200 OK { "abilities" : [ { "device_type" : "IPC", "firmware" : "SDC 10.0.RC11", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "alarm_voice_file_max_num" : "6", "alarm_voice_one_file_max_size" : "76800", "alarm_voice_file_max_size" : "524288", "support" : false } } }, { "device_type" : "IPC", "firmware" : "SDC 10.0.RC12", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "support" : false } } } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 abilities Array of DeviceVersionAndAbilities objects 设备版本对应能力集返回体 表6 DeviceVersionAndAbilities 参数 参数类型 描述 device_type String 设备类型 model String 设备款型 firmware String 设备软件版本 abilities Object 设备能力集规格

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 versions 是 Array of versions objects 设备版本 need_specification 否 Boolean 是否需要返回具体规格，不传默认false ability 否 Array of strings 查询的云上能力集列表，不传默认查询所有能力集 表4 versions 参数 是否必选 参数类型 描述 device_type 是 String 设备类型，必填，可以通过用户根据设备ID查询设备信息详情获取 firmware 是 String 设备软件版本，必填，可以通过用户根据设备ID查询设备信息详情获取 model 是 String 设备固件类型（设备款型），必填，可以通过用户根据设备ID查询设备信息详情获取

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken，从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 state 是 String 授权操作：枚举类型 枚举值： OPENED 开启 CLOSED 关闭 channels 是 Array of strings 通道id集合，集合长度范围[1,65]。目前只支持好望设备，通道id取值范围[-1,999]。通道id为-1时代表设备本身，需要同时对设备及通道操作时同时传入-1及通道id。 当授权对象为直连设备时，此参数可填 ["0"]，设备授权状态也是通道授权状态，因此直连设备授权成功响应不返回channels_result——通道执行结果

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID device_result String 设备授权结果：枚举类型 枚举值： 0 成功 1 失败 channels_result Array of ChannelTargetsAuthResult objects 通道执行结果 表5 ChannelTargetsAuthResult 参数 参数类型 描述 channel_id String 通道id channel_result String 通道授权结果：枚举类型 枚举值： 0 成功 1 失败