智能安防服务API
高容量网关云端接口API
1. 概述
2. API
2.1 人脸管理
2.1.1 新增人脸库
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceGroupCreate |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 新增人脸库 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 是 | String | 产品名 |
deviceName | 是 | String | 设备名 |
groupName | 是 | String | 人脸库名称(最大字符长度63) |
groupType | 否 | Integer | 人脸库类型 1:黑名单 2:白名单 3:员工 4:访客 |
extInfo | 否 | String | 扩展信息 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 |
groupId | String | 人脸库ID |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupName":"test_name"
}
正常返回示例:
{
"code":200,
"message":"success",
"data":{
"groupId":"12"
}
}
2.1.2 删除人脸库
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceGroupRemove |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 删除人脸库 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
groupId | 必填 | String | 人脸库ID(最大字符长度63) |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupId":"12"
}
正常返回示例:
{
"code":200,
"message":"success"
}
2.1.3 修改人脸库
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceGroupModify |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 修改人脸库 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
groupId | 必填 | String | 人脸库ID(最大字符长度63) |
groupName | 必填 | String | 人脸库名称(最大字符长度63) |
groupType | 可选 | Integer | 人脸库类型 1:黑名单 2:白名单 3:员工 4:访客 |
extInfo | 可选 | String | 扩展信息 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupId":"12",
"groupName":"test_name2"
}
正常返回示例:
{
"code":200,
"message":"success"
}
2.1.4 查询人脸库
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceGroupDetail |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 查询人脸库 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
groupId | 必填 | String | 人脸库Id |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 |
groupId | String | 人脸库ID |
groupName | String | 人脸库名称 |
groupFaceNum | Integer | 人脸库入库数量 |
extInfo | String | 扩展信息 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupId":"12"
}
正常返回示例:
{
"code":200,
"message":"success",
"data":{
"groupId":"12",
"groupName":"test_name",
"groupFaceNum":100
}
}
2.1.5 查询所有人脸库
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | getAllFaceGroup |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 查询所有人脸库 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 |
groups | JsonArry |
groups:
名称 | 类型 | 描述 |
groupId | String | 人脸库ID(最大字符长度63) |
groupName | String | 人脸库名称(最大字符长度63) |
groupFaceNum | Integer | 人脸库入库数量 |
extInfo | String | 扩展信息 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name"
}
正常返回示例:
{
"code":200,
"message":"success",
"data":[{
"groupId":"12",
"groupName":"test_name",
"groupFaceNum":10
},{
"groupId":"13",
"groupName":"test_name2",
"groupFaceNum":10
}]
}
2.1.6 新增人脸
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceCreate |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 创建人脸 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
groupId | 必填 | String | 人脸库ID(最大字符长度63) |
facePicUrl | 必填 | String | 人脸图片url |
name | 可选 | String | 姓名(最大字符长度63) |
extInfo | 可选 | String | 扩展信息 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 |
faceId | String | 人脸ID(最大字符长度63) |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupId":"12",
"name":"test_name",
"facePicUrl":"****",
"facePicType":"JPG"
}
正常返回示例:
{
"code":200,
"message":"success",
"data":{
"faceId":"12"
}
}
2.1.7 删除人脸
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceRemove |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 删除人脸 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
groupId | 必填 | String | 人脸库ID(最大字符长度63) |
faceId | 必填 | String | 人脸Id(最大字符长度31) |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupId":"12",
"faceId":"12"
}
正常返回示例:
{
"code":200,
"message":"success"
}
2.1.8 修改人脸
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceModify |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 修改人脸 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
groupId | 必填 | String | 人脸库ID(最大字符长度63) |
faceId | 必填 | String | 人脸Id(最大字符长度31) |
facePicUrl | 可选 | String | 人脸图片url |
name | 可选 | String | 姓名(最大字符长度63) |
extInfo | 可选 | String | 扩展信息 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupId":"12",
"faceId",12,
"name":"test_name2",
"facePicUrl":"****"
}
正常返回示例:
{
"code":200,
"message":"success"
}
2.1.9 搜索人脸
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | faceSearch |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 查询人脸 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
groupId | 必填 | String | 人脸库ID |
name | 可选 | String | 姓名(最大字符长度63) |
extInfo | 可选 | String | 扩展信息 |
pageNo | 可选 | Integer | 分页查询,页码,从1开始 默认为1 |
pageSize | 可选 | Integer | 分页查询,页尺寸 默认为10 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 |
faces | JsonArray | 人脸信息 |
人脸信息 faces:
名称 | 类型 | 描述 |
groupId | String | 人脸库ID(最大字符长度63) |
groupName | String | 人脸库名称(最大字符长度127) |
faceId | String | 人脸Id(最大字符长度31) |
name | String | 姓名(最大字符长度63) |
facePicBase64 | String | 人脸图片base64编码后的数据 |
facePicType | String | 图片类型 JPG PNG BMP |
extInfo | String | 扩展信息 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"groupId":"12",
"name":"test_name2",
"pageNo":1,
"getCount":10
}
正常返回示例:
{
"code":200,
"message":"success",
"data":{
"faces":[{
"groupId":"12",
"groupName":"test_grp_name",
"faceId":"12",
"name":"test_name",
"facePicBase64":"AABB****1122",
"facePicType":"JPG"
},{
"groupId":"12",
"groupName":"test_grp_name",
"faceId":"13",
"name":"test_name2",
"facePicBase64":"AABB****1122",
"facePicType":"JPG"
}]
}
}
2.2 事件布防
2.2.1 设置布防规则
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | setAlarmRule |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 设置布防规则 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
eventType | 必填 | Integer | 事件类型 1:人员识别 2:区域入侵 3:电动车进电梯 4:垃圾桶满溢 5:高空抛物 6:消防通道占用 7:热成像-温度异常 8:热成像-人体测温 100:其他 |
alarmRule | 必填 | JsonArray | 布防计划 |
布防计划 alarmRule:
名称 | 是否必选 | 类型 | 描述 |
weekDay | 必填 | String | 周日期 星期日:SUNDAY 星期一:MONDAY 星期二:TUESDAY 星期三:WEDNESDAY 星期四:THURSDAY 星期五:FRIDAY 星期六:SATURDAY |
timeSlot | 必填 | JSONArray | 时间段 |
bindGroup | 必填 | JSONArray | 人脸底库绑定 eventType== 1 时有效 |
extInfo | 可选 | String | 规则扩展信息 |
时间段 timeSlot:
名称 | 是否必选 | 类型 | 描述 |
time | 必填 | String | 时间范围 0:00-2:00 |
interval | 必填 | Integer | 时间间隔,单位秒 |
timeExtInfo | 可选 | String | 时间段扩展信息 |
人脸底库绑定 bindGroup:
名称 | 是否必选 | 类型 | 描述 |
groupId | 必填 | String | eventType == 1 时有效 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"eventType":1,
"alarmRule":[{
"weekDay":"SUNDAY",
"timeSlot":[{
"time":"00:00-2:00",
"interval":600
},{
"time":"02:00-4:00",
"interval":600
}]
},{
"weekDay":"MONDAY",
"timeSlot":[{
"time":"00:00-23:59",
"interval":600
}]
}]
}
正常返回示例:
{
"code":200,
"message":"success"
}
2.2.2 获取布防规则
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | getAlarmRule |
接口版本号 | 1.0.0 |
请求方法 | POST |
接口描述 | 获取布防规则 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名 |
deviceName | 必填 | String | 设备名 |
eventType | 必填 | Integer | 事件类型 1:人员识别 2:区域入侵 3:电动车进电梯 4:垃圾桶满溢 5:高空抛物 6:消防通道占用 7:热成像-温度异常 8:热成像-人体测温 100:其他 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 |
weekDay | String | 周日期 星期日:SUNDAY 星期一:MONDAY 星期二:TUESDAY 星期三:WEDNESDAY 星期四:THURSDAY 星期五:FRIDAY 星期六:SATURDAY |
timeSlot | JsonArray | 时间段 |
bindGroup | JSONArray | 人脸底库绑定 deviceType == 1 时有效 |
extInfo | String | 规则扩展信息 |
时间段 timeSlot:
名称 | 是否必选 | 类型 | 描述 |
time | 必填 | String | 时间范围 0:00-2:00 |
interval | 必填 | Integer | 时间间隔,单位秒 |
timeExtInfo | 可选 | String | 时间段扩展信息 |
人脸底库绑定 bindGroup:
名称 | 是否必选 | 类型 | 描述 |
groupId | 必填 | String | eventType == 1 时有效 |
示例
请求参数示例:
{
"productKey":"aa****cc",
"deviceName":"test_name",
"eventType":1
}
正常返回示例:
{
"code":200,
"message":"success",
"data":[{
"weekDay":"SUNDAY",
"timeSlot":[{
"time":"00:00-2:00",
"interval":600
},{
"time":"02:00-4:00",
"interval":600
}]
},{
"weekDay":"MONDAY",
"timeSlot":[{
"time":"00:00-23:59",
"interval":600
}]
}]
}
2.2.3 告警事件上报
接入方式 | 数据模型 |
模型ID | securityAlarmEvent |
模型版本号 | 1.2 |
模型描述 | 边缘安防服务告警事件数据模型 |
属性列表
参数 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名称 |
deviceName | 必填 | String | 设备名称 |
eventType | 必填 | String | 事件类型 1:人员识别 2:区域入侵 3:电动车进电梯 4:垃圾桶满溢 5:高空抛物 6:消防通道占用 7:热成像-温度异常 8:热成像-人体测温 0xFF:其他 |
eventTime | 必填 | String | 事件的触发时间 格式:2010-01-01 01:01:11 |
eventId | 必填 | String | 事件ID,事件的唯一标识 |
eventStatus | 可选 | String | 事件状态 0:瞬时 1:开始 2:停止 |
confidence | 可选 | Integer | 事件置信度,0~255,值越大置信度越高 |
picSceneUrl | 可选 | String | 全景图片url |
objectInfo | 可选 | String(JsonArray) | 目标INFO |
extInfo | 可选 | String(Json) | 其他扩展信息 |
目标INFO:objectInfo
参数 | 是否必选 | 类型 | 描述 |
objPicUrl | 可选 | String | 目标图片url |
letfTopX | 可选 | String | 左上角x坐标(0, 8192) |
leftTopY | 可选 | Integer | 左上角y坐标(0, 8192) |
rightBottomX | 可选 | String | 右下角x坐标(0, 8192) |
rightBottomY | 可选 | String | 右下角y坐标(0, 8192) |
objectExtInfo | 可选 | String(Json) | 目标自定义扩展信息 |
ExtInfo:当eventType = 1 人员识别时:
参数 | 是否必选 | 类型 | 描述 |
similarity | 必填 | Float | 相似度 (0, 1) |
groupId | 必填 | String | 人脸所在底库的GroupId |
faceId | 必填 | String | 底库人脸Id |
gender | 可选 | Integer | 性别 1:男 2:女 0xFF:未知 |
glass | 可选 | Integer | 是否戴眼镜 0:未戴眼镜 1:戴眼镜 0xFF:未知 |
mask | 可选 | Integer | 是否戴口罩 0:未戴口罩 1:戴口罩 0xFF:未知 |
pitch | 可选 | Integer | 俯仰角 [-90,90] |
yow | 可选 | Integer | 偏航角 [-90,90] |
roll | 可选 | Integer | 翻滚角 [-90,90] |
faceQuality | 可选 | Integer | 人脸质量 [0-100] |
facePicUrl | 可选 | String | 底库人脸图片url |
ExtInfo:当eventType = 2 区域入侵时:
参数 | 是否必选 | 类型 | 描述 |
targetType | 必填 | Integer | 目标类型 1:人 2:车 0xFF:其他 |
ExtInfo:当eventType = 6 消防通道占用时:
参数 | 是否必选 | 类型 | 描述 |
plateColor | 必填 | Integer | 车牌颜色 0:未知颜色 1:蓝色 2:黄色 3:白色 4:黑色 5:绿色 6:黄绿色 0xFF:其他颜色 |
plateNum | 可选 | String | 车牌号 |
vehicleColor | 必填 | Integer | 车身颜色 1:红色 2:绿色 3:蓝色4:黄色 5:白色 6:灰色 7:黑色 8:紫色 9:棕色 10:粉色 11:银色 12:深蓝 13:深灰 14:青色 0xFF:其他颜色 |
ExtInfo:当eventType = 7 热成像-温度异常时:
参数 | 是否必选 | 类型 | 描述 |
alarmContion | 必填 | Integer | 报警条件 1:大于 2:等于 3:小于 |
tempValue | 必填 | Float | 温度值 |
tempUnit | 必填 | Integer | 温度单位 1:摄氏度 2:华氏度 |
ExtInfo:当eventType = 8 热成像-人体测温时:
参数 | 是否必选 | 类型 | 描述 |
tempMax | 必填 | Float | 最高温度 |
tempUnit | 必填 | Integer | 温度单位 1:摄氏度 2:华氏度 |
2.3 抓图计划
2.3.1 设置抓图计划
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | setPicCaptureTask |
接口版本号 | 1.0.3 |
请求方法 | POST |
接口描述 | 设置抓图计划 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
taskId | 必填 | String | 任务的唯一标识 |
deviceList | 必填 | JSONArray | 关联的监控设备 |
startDate | 必填 | String | 计划开始时间 格式:YYYY-MM-DD |
endDate | 必填 | String | 计划结束时间 格式:YYYY-MM-DD |
captureWeekDay | 可选 | JsonArray | 抓图周期 captureWeekDay和cron二选一必填 |
cron | 可选 | JsonArray | cron表达式 captureWeekDay和cron二选一必填 |
status | 必填 | Integer | 启用状态 1:启用 0:禁用 |
extInfo | 可选 | String | 扩展字段 |
设备列表:deviceList:
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名称 |
deviceName | 必填 | String | 设备名称 |
抓图周期:captureWeekDay
名称 | 是否必选 | 类型 | 描述 |
weekDay | 必填 | String | 周日期 星期日:SUNDAY 星期一:MONDAY 星期二:TUESDAY 星期三:WEDNESDAY 星期四:THURSDAY 星期五:FRIDAY 星期六:SATURDAY |
captureTime | 必填 | JsonArray | 抓图时分 24时制,格式: [hh:mm,hh2:mm2] |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"taskId":"123",
"deviceList":[{
"productKey":"aa****cc",
"deviceName":"test_name"
},{
"productKey":"aa****cc",
"deviceName":"test_name2"
}],
"startDate":"2010-01-01",
"endDate":"2010-04-01",
"captureWeekDay":[{
"weekDay":"SUNDAY",
"captureTime":["10:00","12:00"]
},{
"weekDay":"MONDAY",0
"captureTime":["10:00","12:00"]
}],
"status":1
}
正常返回示例:
{
"code":200,
"message":"success"
}
2.3.2 获取抓图计划
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | getPicCaptureTask |
接口版本号 | 1.0.1 |
请求方法 | POST |
接口描述 | 获取抓图计划 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
taskId | 必填 | String | 任务的唯一标识 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 | |
deviceList | 必填 | JSONArray | 关联的监控设备 |
startDate | 必填 | String | 计划开始时间 格式:YYYY-MM-DD |
endDate | 必填 | String | 计划结束时间 格式:YYYY-MM-DD |
captureWeekDay | 可选 | JsonArray | 抓图周期 captureWeekDay和cron二选一必填 |
cron | 可选 | List | cron表达式 captureWeekDay和cron二选一必填 |
status | 必填 | Integer | 启用状态 1:启用 0:禁用 |
extInfo | 可选 | String | 扩展字段 |
设备列表:deviceList:
名称 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名称 |
deviceName | 必填 | String | 设备名称 |
抓图周期:captureWeekDay
名称 | 是否必选 | 类型 | 描述 |
weekDay | 必填 | String | 周日期 星期日:SUNDAY 星期一:MONDAY 星期二:TUESDAY 星期三:WEDNESDAY 星期四:THURSDAY 星期五:FRIDAY 星期六:SATURDAY |
captureTime | 必填 | JsonArray | 抓图时分 24时制,格式: [hh:mm,hh2:mm2] |
示例
请求参数示例:
{
"taskId":"123"
}
正常返回示例:
{
"code":200,
"message":"success",
"data":{
"deviceList":[{
"productKey":"aa****cc",
"deviceName":"test_name"
},{
"productKey":"aa****cc",
"deviceName":"test_name2"
}],
"startDate":"2010-01-01",
"endDate":"2010-04-01",
"captureWeekDay":[{
"weekDay":"SUNDAY",
"captureTime":"10:00,12:00"
},{
"weekDay":"MONDAY",
"captureTime":"10:00,12:00"
}],
"status":1
}
}
2.3.3 删除抓图计划
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | removeCaptureTask |
接口版本号 | 1.0.1 |
请求方法 | POST |
接口描述 | 删除抓图计划 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
taskId | 必填 | String | 任务的唯一标识 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"taskId":"123"
}
正常返回示例:
{
"code":200,
"message":"success"
}
2.3.4 抓图记录上报
接入方式 | 数据模型 |
模型ID | securityCapture |
模型版本号 | 1.0 |
模型描述 | 智能安防抓图记录 |
属性列表
参数 | 是否必选 | 类型 | 描述 |
productKey | 必填 | String | 产品名称 |
deviceName | 必填 | String | 设备名称 |
taskId | 可选 | String | 任务ID |
captureTime | 必填 | Long | 抓图时间,UTC时间,精确到s |
picUrl | 必填 | String | 抓拍图片的url |
2.4 抓拍记录查询
2.4.1 抓拍记录查询
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | getPicRecord |
接口版本号 | 1.0.1 |
请求方法 | POST |
接口描述 | 抓拍记录查询 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
picBase64 | 必填 | String | 图片Base64 |
picType | 必填 | String | 图片类型 JPG PNG BMP |
recordLimit | 必填 | Integer | 获取记录数量限制 |
startTime | 必填 | Long | UTC时间,精确到s |
endTime | 必填 | Long | UTC时间,精确到s endTime与startTime相差<=24h |
minSimilarity | 必填 | Float | 最小相似度(0,1) |
maxSimilarity | 必填 | Float | 最大相似度(0,1) maxSimilarity > minSimilarity |
pageNo | 可选 | Integer | 分页查询,页码,从1开始 默认为1 |
pageSize | 可选 | Integer | 分页查询,页尺寸,pageSize>1&pageSize<=20 默认为10 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
data | JSON | 响应结果 |
响应结果 data:
名称 | 类型 | 描述 |
recordList | JsonArray | 记录列表 |
记录列表:recordList:
名称 | 类型 | 描述 |
productKey | String | 产品名称 |
deviceName | String | 设备名称 |
smallPicBase64 | String | 小图base64 |
smallPicType | String | 图片类型 JPG PNG BMP |
scenePicId | String | 场景图id |
similarity | Float | 相似度(0,1) |
captureTime | Long | UTC时间,精确到s |
extinfo | JsonArray | 眼镜,性别,年龄等 |
示例
请求参数示例:
{
"picBase64":"AABB****1122",
"picType":"JPG",
"recordLimit":10,
"startTime":1631794685,
"endTime":1631798285,
"minSimilarity":0.55,
"maxSimilarity":0.65
}
正常返回示例:
{
"code":200,
"message":"success",
"data":{
"recordList":[{
"productKey":"aa****cc",
"deviceName":"test_name",
"smallPicBase64":"AABB****1122",
"smallPicType":"JPG",
"scenePicId":"pic1234",
"similarity":0.6,
"captureTime":1631795685
},{
"productKey":"aa****cc",
"deviceName":"test_name",
"smallPicBase64":"AABB****1122",
"smallPicType":"JPG",
"scenePicId":"pic1235",
"similarity":0.6,
"captureTime":1631795685
}]
}
}
2.4.2 抓拍记录场景图获取
接入方式 | 服务模型 |
模型ID | smartSecurityService |
模型版本号 | 1.0.4 |
接口名称 | scenePicRecordUpload |
接口版本号 | 1.0.1 |
请求方法 | POST |
接口描述 | 抓拍记录场景图获取 |
Content-Type | application/json |
请求参数
名称 | 是否必选 | 类型 | 描述 |
scenePicId | 必填 | String | 场景图ID |
uploadUrl | 必填 | String | upload地址 |
返回数据
名称 | 类型 | 描述 |
code | Int | 接口返回码。200表示成功。 |
message | String | 调用失败时,返回的出错信息。 |
localizedMsg | String | 本地语言的错误消息。 |
示例
请求参数示例:
{
"scenePicId":"pic1234",
"uploadUrl":"https://xxxxx"
}
正常返回示例:
{
"code":200,
"message":"success"
}
3. 附录
3.1 错误码
code | message | 说明 |
200 | success | 成功 |
804 | param check error: /'%s/' | 参数校验失败,返回失败的参数 |