-
URI PUT /v1/{user_id}/devices/{device_id}/gb-account 表1 路径参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR），用来区分设备类型 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节
-
响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 targets Array of TargetAdd objects 添加目标ID列表 表6 TargetAdd 参数 参数类型 描述 target_id String 目标ID：目标标识符 name String 目标名称 external_target_id String 用户传入的名单库ID jpegBase64 String 图片内容，经过base64编码 result Result object 结果信息 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息
-
请求示例 批量添加目标 POST /v1/2562572829***/targets/batch-add
{
"device_id":"952352LWXT***",
"group_id":2,
"targets":[
{
"name":"mark",
"gender":"male",
"age":24,
"country":"中国",
"nation":"汉",
"native":"杭州",
"occupation":"工人",
"work_no":"124****77",
"phone":"15********61",
"email":"1*********@qq.com",
"domicile":"杭州",
"external_target_id":"10",
"remark":"无",
"jpegBase64":"/9j/4AAQSkZJRgABAQAAAQABAAD..."}]
}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取，NVR默认陌生人分组不可以添加目标 targets 是 Array of AddTargetsDto objects 目标数据列表： NVR800和IVS1800：9.1以上版本支持该接口，支持批量添加，最多支持添加20个目标，NVR800的所有图片合计最大为700K，像素大小在1200*1200以内，NVR800在脱敏库中目标无法进行修改 SDC：仅支持单目标添加 storage 否 Boolean 是否保存图片：false-不保存图片，true-保存图片，默认值true，NVR800的不保存图片就会保存到脱敏名单库中，SDC和NVR800修改时该字段不生效 表4 AddTargetsDto 参数 是否必选 参数类型 描述 name 是 String 姓名：支持中英文、数字、特殊字符（_-空格），长度范围[1,128] gender 是 String 性别：枚举类型 枚举值： male 男性 female 女性 age 否 Integer 年龄：取值范围[1,255]（仅NVR800支持） country 否 String 国家：支持大小写字母数字，长度范围[1,128]（SDC不支持） nation 否 String 民族：支持大小写字母数字，长度范围[1,32]（暂不支持） native 否 String 籍贯：支持大小写字母数字，长度范围[1,128]（IVS1800不支持） occupation 否 String 职业：支持大小写字母数字，长度范围[1,128]（SDC不支持） work_no 否 String 工号或身份证号之类：支持大小写数字，长度范围[1,64] phone 否 String 电话：11位纯数字（仅NVR800支持） email 否 String 邮箱：邮箱格式，***@.***（仅NVR800支持） domicile 否 String 居住地：支持大小写字母数字，长度范围[1,256]（IVS1800不支持） remark 否 String 备注信息：支持大小写字母数字，长度范围[1,512]（SDC不支持） jpegBase64 是 String 目标图片：经过base64编码（单个图片建议不超过50K），像素大小在1200*1200以内，支持png、jpeg、jpg格式 external_target_id 否 String 用户传入的目标id：支持大小写英文、数字、_，长度范围[1,64]，NVR800不保存图片必须传external_target_id
-
请求示例 添加国标协议设备 POST /v1/2562572829***/devices/gb/batch-add
{
"devices" : [ {
"device_id" : "952352LWXT***",
"device_name": "DEVICE01",
"device_username" : "admin",
"device_password" : "***",
"algorithm": "MD5"
} ]
}
-
响应示例 状态码： 200 OK {
"failed_num" : 0,
"devices" : [ {
"device_id" : "952352LWXT***",
"sip_server_id" : "3402000000***",
"sip_server_domain" : "3402***",
"sip_server_host" : "123.123.*.*",
"sip_server_port" : "5060",
"result" : {
"code" : "IVM.0",
"msg" : "Success"
}
} ]
}
-
响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 devices Array of BatchAddGBDevicesRespItem objects 添加结果详细信息 表6 BatchAddGBDevicesRespItem 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 sip_server_id String SIP服务器ID sip_server_domain String SIP服务器域 sip_server_host String SIP服务器地址 sip_server_port String SIP服务器端口 result Result object 错误或成功信息 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息
-
响应示例 状态码： 200 OK {
"group_id" : 2,
"target_ids" : [ {
"result" : {
"code" : "IVM.0",
"msg" : "Success"
},
"target_id" : "2",
"external_target_id" : "1234567890123456"
} ]
}
-
请求示例 批量修改目标信息 PUT /v1/2562572829***/targets
{
"device_id":"952352LWXT***",
"group_id":2,
"targets":[
{
"target_id":"2",
"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..."}]
}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 targets 是 TargetDto object 目标数据列表： NVR800和IVS1800：9.1以上版本支持该接口，支持批量修改，最多支持修改20个目标，NVR800的所有图片合计最大为700K，NVR800在脱敏库中目标无法进行修改 SDC：仅支持单目标修改 storage 否 Boolean 是否保存图片：false-不保存图片，true-保存图片，默认值true，NVR800的不保存图片就会保存到脱敏名单库中，SDC和NVR800修改时该字段不生效 表4 TargetDto 参数 是否必选 参数类型 描述 target_id 是 String 目标ID：支持数字和-，长度范围[1,20]，需要已添加目标才可以修改，可以从按索引范围获取目标ID列表、获取目标信息、按索引范围获取目标ID信息中获取 name 是 String 姓名：支持中英文、数字、特殊字符（_-空格），长度范围[1,128] gender 是 String 性别：枚举类型 枚举值： male 男性 female 女性 age 否 Integer 年龄：取值范围[1,255]（仅NVR800支持） country 否 String 国家：支持大小写字母数字，长度范围[1,128]（SDC不支持） nation 否 String 民族：支持大小写字母数字，长度范围[1,32]（暂不支持） native 否 String 籍贯：支持大小写字母数字，长度范围[1,128]（IVS1800不支持） occupation 否 String 职业：支持大小写字母数字，长度范围[1,128]（SDC不支持） work_no 否 String 工号或身份证号之类：支持大小写数字，长度范围[1,64] phone 否 String 电话：11位纯数字（仅NVR800支持） email 否 String 邮箱：邮箱格式，***@.***（仅NVR800支持） remark 否 String 备注信息：支持大小写字母数字，长度范围[1,512]（SDC不支持） jpegBase64 是 String 目标图片：经过base64编码（单个图片建议不超过50K），支持png、jpeg、jpg格式 domicile 否 String 居住地：支持大小写字母数字，长度范围[1,256]（IVS1800不支持）
-
响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 group_id Integer 目标库分组ID：目标库标识符 target_ids Array of TargetResultVo objects 目标ID列表 表6 TargetResultVo 参数 参数类型 描述 target_id String 目标ID：目标标识符 result Result object 结果信息 external_target_id String 用户传入的目标ID：用户自定义的，在添加目标的时候由客户填入 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息
-
响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 录像文件总数量 records Array of ListDeviceRecordFilesResp objects 录像列表 表5 ListDeviceRecordFilesResp 参数 参数类型 描述 record_name String 录像文件名称：长度范围[1,32] record_type String 录像类型：枚举类型 枚举值： NORMAL_RECORD 全量： 录像计划产生的录像 MOTION_RECORD 动检： 移动侦测产生的录像 AL
RAM _RECORD 告警： 智能分析，目标分析等告警输入产生的录像 start_time String 录像开始时间：格式：yyyy-MM-dd HH:mm:ss end_time String 录像结束时间：格式：yyyy-MM-dd HH:mm:ss
-
URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-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 limit 否 String 单页数量：取值范围[1,1000]，不填写时默认值为 10 offset 否 String 偏移量：offset为0时表示查询第一页的数据，取值范围[0,1000000]，不填写时默认值为 0
-
响应示例 状态码： 200 查询设备的录像列表（国标）响应 {
"total" :0,
"records" : [ {
"record_name" : "录像1",
"record_type" : "NORMAL_RECORD",
"start_time" : "2020-06-12 17:31:00",
"end_time" : "2020-06-16 17:31:00"
} ]
}
-
响应参数 状态码： 200 表5 响应Body参数：播放P2P实况需要将响应Body参数中的所有内容输入到播放地址栏 参数 参数类型 描述 fail_num Integer 获取设备url失败的数量 live_connections Array of LiveConnectionResp objects 实况响应信息 表6 LiveConnectionResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] cloud_trans_connections CloudTransChannelsResp object 转发实况连接结构体 p2p_connections P2PChannelsResp object P2P实况连接结构体：仅支持HOLO媒体播放协议且请求设备为好望设备 result Result object 错误信息 表7 CloudTransChannelsResp 参数 参数类型 描述 live_url String 转发实况播放地址：将此url输入播放地址栏开始播放 表8 P2PChannelsResp 参数 参数类型 描述 token String P2P请求Token device_state String 在线状态：枚举类型 枚举值： OFFLINE 离线 ONLINE 在线 p2p_nodes Array of P2PMTSListResp objects P2P连接可用节点 表9 P2PMTSListResp 参数 参数类型 描述 node_type String 节点类型：枚举类型 枚举值： COMMON 普通：普通的三线（移动，联通，电线）服务器，与地域有关，服务器由运营商托管，网络通信质量低 BETTER 优质：全网通服务器（华为云服务器等），网络通信质量高 address_type String 地址类型：枚举类型 DOMAIN 域地址 IPV4 IPv4地址 IPV6 IPv6地址 address Array of strings 媒体转发服务地址： 协议头在SDK封装 ，根据address_type决定地址类型 DOMAIN: www.huawei.com IPV4: 123.123.123.123 IPV6: fe80::f816:3eff:feed:5821 tcp_port Integer TCP端口：默认值为 0 备注：未使用0端口，tcp_port只作为兼容字段保留 udp_port Integer UDP端口：默认值为 7050 表10 Result 参数 参数类型 描述 code String 错误编码：请参见错误码 msg String 错误信息
