- 1.设置进门拌线坐标
- 2.获取进门拌线坐标
- 3.获取指定时间内的进入人流统计信息
- 4.获取指定时间内的路过人流统计信息
- 5.获取指定时间内的外出人流统计信息
- 6.获取指定时间内的来访列表
- 7.获取指定人脸的来访记录
- 8.获取人流统计设置
- 9.更新人流统计设置
1.设置进门拌线坐标
描述
进门拌线是IPC设备用来判断某个人是否已经进来的基础,因此对于人脸识别和客流统计,需要通过此接口来设置这个拌线的坐标。
请求地址
https://192.168.0.1/openapi/peopleFlow/setDoorLine,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
resolution | int | 只能取值0和1,0表示1080P的分辨率,1表示720P的分辨率 | Y | 0 |
start_x | int | 拌线的左边端点X坐标,1080p范围0<=x<=1920,720p范围0<=x<=1280 | Y | 500 |
start_y | int | 拌线的左边端点Y坐标,1080p范围0<=y<=1080,720p范围0<=y<=720 | Y | 500 |
end_x | int | 拌线的右边端点X坐标,1080p范围0<=x<=1920,720p范围0<=x<=1280 | Y | 500 |
end_y | int | 拌线的右边端点Y坐标,1080p范围0<=y<=1080,720p范围0<=y<=720 | Y | 500 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、277,278,见错误码的描述 |
请求示例
POST openapi/peopleFlow/setDoorLine HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&resolution=0&start_x=1200&start_y=900&end_x =1500&end_y=900 |
返回示例
{
"code": 0
}
2.获取进门拌线坐标
描述
获取进门拌线的坐标信息。
请求地址
https://192.168.0.1/openapi/peopleFlow/getDoorLine,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、260、261、262、263、264、276、277、279,见错误码的描述 |
resolution | int | 取值0和1,0表示1080P的分辨率,1表示720P的分辨率 |
start_x | int | 拌线的左边端点X坐标 |
start _y | int | 拌线的左边端点Y坐标 |
end_x | int | 拌线的右边端点X坐标 |
end_y | int | 拌线的右边端点Y坐标 |
请求示例
POST openapi/peopleFlow/getDoorLine HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{
"code": 0,
"data": {
"resolution": 0,
"start_x": 1200,
"start_y": 900,
"end_x": 1500,
"end_y": 900
}
}
3.获取指定时间内的进入人流统计信息
描述
获取指定某一时间内的人流统计信息,如果设备不存在这个时间内的信息则会返回错误。
请求地址
https://192.168.0.1/openapi/peopleFlow/getComeInPeopleStat,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
start_time | long | Unix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小 时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者 2019-07-01 10:30这样的时间对应的时间戳。 | Y | 1578969264 |
end_time | long | Unix格式时间戳,精确至秒,结束时间。时间要求同上。 | Y | 1579055640 |
period | int | 人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别 为1,2和3。 | Y | 2 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
total | int | 总人流数量/统计粒度内的人流数量 |
start_time | long | 统计粒度的开始时间 |
end_time | long | 统计粒度的结束时间 |
male_num_stat | array | 整数数组,表示男性统计数据,共有8个整数,从第一个整数开始依次表 示1~6岁、7~12岁、13~18岁、19~28岁、29~35岁、36~45岁、46~55岁、 56岁~100岁的男性人数。 |
female_num_stat | array | 整数数组,表示女性统计数组,含义同上 |
请求示例
POST openapi/peopleFlow/getComeInPeopleStat HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3 |
注:本示例表示获取2019-07-01到2019-07-02这两天的统计信息,且统计信息以天为粒度的人流统计信息。
返回示例
{
"code": 0,
"data": {
"total": 2998,
"stat_list": [{
"start_time": 1561910400,
"end_time": 1561996800,
"total": 1499,
"male_num_stat": [10, 20, 50, 109, 280, 380, 156, 10],
"female_num_stat": [11, 34, 50, 78, 132, 45, 123, 11]
},
{
"start_time": 1561996800,
"end_time": 1562083200,
"total": 1499,
"male_num_stat": [10, 20, 50, 109, 280, 380, 156, 10],
"female_num_stat": [11, 34, 50, 78, 132, 45, 123, 11]
}]
}
}
4.获取指定时间内的路过人流统计信息
描述
获取指定某一时间内的经过人流统计信息,如果设备不存在这个时间内的信息则会返回错误。
请求地址
https://192.168.0.1/openapi/peopleFlow/getPassByPeopleStat ,192.168.0.1 需要替换成实际的 IPC 地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
start_time | long | Unix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小 时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者 2019-07-01 10:30这样的时间对应的时间戳。 | Y | 1578969264 |
end_time | long | Unix格式时间戳,精确至秒,结束时间。时间要求同上。 | Y | 1579055640 |
period | int | 人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别 为1,2和3。 | Y | 2 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
total | int | 总人流数量/统计粒度内的人流数量 |
start_time | long | 统计粒度的开始时间 |
end_time | long | 统计粒度的结束时间 |
请求示例
POST openapi/peopleFlow/getPassByPeopleStat HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3 |
注:本示例表示获取2019-07-01到2019-07-02这两天的统计信息,且统计信息以天为粒度的人流统计信息。
返回示例
{
"code": 0,
"data": {
"total": 2998,
"stat_list": [{
"start_time": 1561910400,
"end_time": 1561996800,
"total": 1513
}, {
"start_time": 1561996800,
"end_time": 1562083200,
"total":1485
}]
}
}
5.获取指定时间内的外出人流统计信息
描述
获取指定某一时间内的人流统计信息,如果设备不存在这个时间内的信息则会返回错误。
请求地址
https://192.168.0.1/openapi/peopleFlow/ getGoOutPeopleStat ,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
start_time | long | Unix格式时间戳,精确至秒,开始时间,时间是整小时或者整天或者半小 时的时间戳,譬如2019-07-01,2019-07-01 10:00,或者 2019-07-01 10:30这样的时间对应的时间戳。 | Y | 1578969264 |
end_time | long | Unix格式时间戳,精确至秒,结束时间。时间要求同上。 | Y | 1579055640 |
period | int | 人流统计信息的粒度,分为30min、hour和day三种统计粒度,取值分别 为1,2和3。 | Y | 2 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
total | int | 总人流数量/统计粒度内的人流数量 |
start_time | long | 统计粒度的开始时间 |
end_time | long | 统计粒度的结束时间 |
请求示例
POST openapi/peopleFlow/getGoOutPeopleStat HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192& timestamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3 |
注:本示例表示获取2019-07-01到2019-07-02这两天的统计信息,且统计信息以天为粒度的人流统计信息。
返回示例
{
"code": 0,
"data": {
"total": 2998,
"stat_list": [{
"start_time": 1561910400,
"end_time": 1561996800,
"total": 1513
}, {
"start_time": 1561996800,
"end_time": 1562083200,
"total":1485
}]
}
}
6.获取指定时间内的来访列表
描述
获取指定时间内,来过次数排名前N的人脸ID列表信息。
请求地址
https://192.168.0.1/openapi/peopleFlow/getVisitorList,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
start_time | long | Unix时间戳 | Y | 1578969264 |
end_time | long | Unix时间戳 | Y | 1579055640 |
order | int | 表示抵达次数排名前order的人脸信息 | Y | 50 |
group_name | string | 指定某个人脸分组,默认为所有人脸分组 | N | vip |
gender | int | 性别,1表示男性,2表示女性,默认不分性别 | N | 1 |
age_range | int | 年龄段,1表示1~6岁,2表示7~12岁,3表示13~18岁,4表示19~28岁, 5表示29~35岁,6表示36~45岁,7表示45~55岁,8表示55岁~100 | N | 4 |
age | int | 年龄,与上面age_range是或的关系,不是与的关系。即查询age_range或 者age满足的人脸,只要有一个符合即可。 | N | 4 |
item1 | string | 可以根据自定义属性来匹配,自定义属性1的匹配。如果需要使用自定义属 性查询,请确保指定的人脸分组添加过对应的自定义属性,否则查询失败(生 人与熟人分组不能添加自定义属性) | N | value1 |
item2 | string | 自定义属性2的匹配 | N | value2 |
item3 | string | 自定义属性3的匹配 | N | value3 |
item4 | string | 自定义属性4的匹配 | N | value4 |
item5 | string | 自定义属性5的匹配 | N | value5 |
page_num | int | 当前页码,默认值和最小值为1 | N | 1 |
page_size | int | 当前页面条目数,默认为10,范围为[1, 100] | N | 10 |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
total_num | int | 符合条件的总人脸数量 |
return_num | int | 当前人脸数量 |
faceid | string | 人脸ID |
group_name | string | 所属分组 |
age | string | 年龄,为空则表示没有设置真实年龄 |
age_range | int | 1表示1~6岁,2表示7~12岁,3表示13~18岁,4表示19~28岁,5表示 29~35岁,6表示36~45岁,7表示45~55岁,8表示55岁~100 |
gender | int | 性别, 0表示未知,1表示男性,2表示女性 |
arrive_times | int | 到达过的次数 |
item1 | string | 自定义属性1,用户添加过才会返回 |
item2 | string | 自定义属性2,用户添加过才会返回 |
item3 | string | 自定义属性3,用户添加过才会返回 |
item4 | string | 自定义属性4,用户添加过才会返回 |
item5 | string | 自定义属性5,用户添加过才会返回 |
请求示例
如下是获取VIP贵宾中30岁男性在2019-06-14到2019-06-15两天内到过次数最多的人脸ID列表信息。
POST openapi/peopleFlow/getVisitorList HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& order=2&start_date=1560441600&end_date=1560528000&gropu_name=vip&age=30&gender=1&item1=value1&&item2=value2&&item3=value3&&item4=value5&&item5=value5 |
返回示例
{
"code": 0,
"data": {
"total_num": 2,
"return_num": 2,
"face_list": [{
"faceid": "000001",
"group_name": "vip",
"age": "32",
"age_range": 5,
"gender': 1,
"arrive_times": 100,
"item1": value1, //自定义属性
"item2": value2, //自定义属性
"item3": value3, //自定义属性
"item4": value4, //自定义属性
"item5": value5 //自定义属性
}, {
"faceid": "000002",
"group_name": "vip",
"age": "30",
"age_range": 5,
"gender": 1,
"arrive_times": 99,
"item1": value1, //自定义属性
"item2": value2, //自定义属性
"item3": value3, //自定义属性
"item4": value4, //自定义属性
"item5": value5 //自定义属性
}]
}
}
7.获取指定人脸的来访记录
描述
查询指定某个人在指定时间内的到访记录。
请求地址
https://192.168.0.1/openapi/peopleFlow/getFaceVisitDetail,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
start_time | long | Unix时间戳,开始时间 | Y | 1578969264 |
end_time | long | Unix时间戳,结束时间 | Y | 1579055640 |
faceid | string | 人脸ID | Y | 000001 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220、265、266、267、277、280,见错误码的描述 |
total_times | int | 总到访次数 |
came_in_time | long array | 到访的具体时间戳 |
请求示例
POST openapi/peopleFlow/getFaceVisitDetail HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&faceid=000002 |
注:本示例表示获取2019-07-01到2019-07-02这两天faceid为000002的人脸的到访时间记录。
返回示例
{
"code": 0,
"data": {
"total_times": 2,
"came_in_time": [1561910400, 1561996800]
}
}
8.获取人流统计设置
描述
查询指定某个人在指定时间内的到访记录。
请求地址
https://192.168.0.1/openapi/peopleFlow/getConfig,192.168.0.1需要替换成实际的IPC地址。
请求参数
本接口没有私有参数,公共参数见公共参数一节描述。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211,见错误码的描述 |
facerecog_interval | int | 设备端人脸识别去重时间间隔,单位秒。 |
请求示例
POST openapi/peopleFlow/getConfig HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{
"code": 0,
"data": {
"facerecog_interval": 60
}
}
9.更新人流统计设置
描述
查询指定某个人在指定时间内的到访记录。
请求地址
https://192.168.0.1/openapi/peopleFlow/setConfig,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
facerecog_interval | int | 设备端人脸识别去重时间间隔,单位秒,取值范围[0,86400]。 | Y | 60 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211,见错误码的描述 |
请求示例
POST openapi/peopleFlow/getConfig HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&facerecog=60 |
返回示例
{
"code": 0
}