- 新建人脸分组
- 编辑人脸分组
- 设置生人到熟人的迁移条件
- 删除人脸分组
- 获取人脸分组列表
- 新增人脸的属性
- 删除人脸的属性
- 获取指定人脸分组新增属性列表
- 新增人脸
- 删除人脸
- 更新人脸
- 获取人脸
- 获取人脸列表
- 获取人脸ID列表
- 获取到达时间最旧的人脸
- 清空指定人脸分组
1. 新建人脸分组
描述
通过此接口新建一个人脸分组,并配置其属性。人脸分组当前最多支持10个,系统默认存在两个人脸分组,分别是生人分组和熟人分组,即用户最多还可以创建8个分组。
请求地址
https://192.168.0.1/ openapi/face/createGroup, 192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
name | string | 分组名称,不长于32个汉字,目前系统默认存在“生人”和 “熟人”两个分组 | Y | 生人 |
capacity | int | 分组容量,所有分组容量加起来不得超过3W | Y | 10000 |
description | string | 分组的描述,不超过50个汉字。 | Y | 黑卡的客户 |
注:
1. 名称第一个字符不得为空格 ;
2. 默认生人库名为stranger,默认熟人库名为regular 。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、200、201、202、211、212、220,见错误码的描述 |
请求示例
POST openapi/face/createGroup HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& name=vip&capacity=10000&description=贵宾人脸分组 |
返回示例
{ “code”: 0 } |
2. 编辑人脸分组
描述
通过此接口编辑指定人脸分组的属性。
请求地址
https://192.168.0.1/openapi/face/updateGroup,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
old_name | string | 要编辑的人脸分组名称 | Y | 黑卡客户 |
name | string | 修改后的分组名称,可与旧的一样 | Y | 金卡客户 |
capacity | int | 修改后的分组容量,可与旧的一样 | Y | 10000 |
description | string | 分组的描述,不超过50个汉字。 | Y | 办卡升级 |
注:
1.修改默认生人分组和熟人分组的属性时候,name必须与old_name一致,即不允许修改默认分组的组名;
2.名称第一个字符不得为空格。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、200、201、202、204、211、212、220,见错误码的描述 |
请求示例
POST openapi/face/updateGroup HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& old_name=stranger&name=vip&capacity=10000&description=贵宾人脸分组 |
返回示例
{ “code”: 0 } |
3. 设置生人到熟人的迁移条件
描述
系统在激活时会默认创建生人分组和熟人分组两个组,且设备会默认把某个生人来的次数满足一定条件(默认7天内来了5次)的情况下,自动把这个生人移动到熟人分组。
通过此接口可修改生人移动到熟人分组的移动条件。
请求地址
https://192.168.0.1/openapi/face/updateMigration,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
arrive_times | int | 必选,生人分组才需要的属性,取值范围1~10 | Y | 5 |
period | int | 必选,生人分组才需要的属性,取值范围1~100,单位为天 | Y | 20 |
注:
arrive_times和period是生人分组才需要修改的属性,代表一个生人在一定时间内(period设置,单位为天)来过多少次(arrive_times设置)就移动到熟人分组中去。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、204、211、220,见错误码的描述 |
请求示例
POST openapi/face/updateMigrationHTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&arrive_times=5&period=3 |
返回示例
{ “code”: 0 } |
4. 删除人脸分组
描述
删除指定人脸分组。
请求地址
https://192.168.0.1/openapi/face/deleteGroup,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
name | string | 要删除的分组名称,生人和熟人分组不能被删除,分组中有人脸也不能删除,只能先清空。 | Y | 黑卡客户 |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、201、204、205、211、220,见错误码的描述 |
请求示例
POST openapi/face/deleteGroup HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& name=vip |
返回示例
{ “code”: 0 } |
5. 获取人脸分组列表
描述
通过此接口获取IPC上所有的人脸分组信息。
请求地址
https://192.168.0.1/openapi/face/getGroupList,192.168.0.1需要替换成实际的IPC地址。
请求参数
此接口不需要私有参数,公共参数见公共参数一节描述。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211、220,见错误码的描述 |
num | int | 分组的数量 |
name | string | 分组名称 |
capacity | int | 分组的容量 |
description | string | 分组的描述 |
times | int | 生人分组才有的属性 |
period | int | 生人分组才有的属性 |
count | int | 当前分组的大小,即有多少人脸记录 |
请求示例
POST openapi/face/getGroupList HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K |
返回示例
{ “data”: { “face_group”: [ { “capacity”: 5000, “count”: 0, “name”: “regular”,//熟人分组 “description”: “this is regular group” }, { “capacity”: 1000, “count”: 0, “name”: “employee”, “description”: “this is employee group” }, { “capacity”: 1000, “count”: 0, “name”: “blacklist”, “description”: “this is blacklist group” }, { “name”: “stranger”,//生人分组 “times”: 5, “capacity”: 1000, “count”: 0, “period”: 2, “description”: “this is stranger group” } ], “num”: 4 }, “code”: 0 } |
6. 新增人脸的属性
描述
库中给每个人脸预置了一些属性,可以通过此接口为指定人脸分组中的人脸增加最多5个属性。
强烈建议在创建新分组后添加人脸前,按需求先调用本接口添加人脸的属性,而不是在添加人脸后中途调用本接口添加人脸ID属性。
请求地址
https://192.168.0.1/openapi/face/addFaceInfoItem,192.168.0.1需要替换成实际的IPC地址。
请求参数
私有参数如下,公共参数见公共参数一节描述。
字段名称 | 类型 | 描述 | 是否必须 | 示例 |
num | int | 新增属性数量 | Y | 1 |
group_name | string | 人脸分组名称 | Y | stranger |
name_list | string array | 类型为数组,属性名称列表,每个属性类型是string,属性长度最大为50字节 | Y | [“stranger”] |
注:
1. 默认库不允许添加人脸ID属性;
2. 以下字段作为保留字段,不允许作为新添加的属性名: group_name, pic, age, gender, faceid, age_range, arrive_times, pic_url, total_num, return_num。
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、204、211、220、240、241、242,见错误码的描述 |
请求示例
POST openapi/face/addFaceInfoItem HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& num=2&group_name=vip&name_list=[“phone_num”, “weight”] |
返回示例
{ “code”: 0 } |
7. 删除人脸的属性
描述
对于指定分组中的自定义属性,用户可以在不需要的时候删除,这里建议用户不要轻易删除。
请求地址
https://192.168.0.1/openapi/face/removeFaceInfoItem,192.168.0.1需要替换成实际的IPC地址。
请求参数
私有参数如下,公共参数见公共参数一节描述。
字段名称 | 类型 | 描述 | 是否必须 | 示例 |
num | int | 删除的属性数量 | Y | 1 |
group_name | string | 人脸分组名称 | Y | stranger |
name_list | string | 数组,属性名称列表,属性长度最大为50字节 | Y | [“stranger”] |
注:
默认库不允许删除人脸ID属性
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、204、211、220、240、241、242、243,见错误码的描述 |
请求示例
POST openapi/face/removeFaceInfoItem HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& num=2&group_name=vip&name_list=[“phone_num”, “weight”] |
返回示例
{ “code”: 0 } |
8. 获取指定人脸分组新增属性列表
描述
通过此接口可以查询某个特定人脸分组中用户通过2.4.6指令添加的所有属性列表。
请求地址
https://192.168.0.1/openapi/face/getFaceInfoItem,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
group_name | string | 分组名称 | Y | stranger |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、204、211、220,见错误码的描述 |
num | int | 属性的数量 |
name_list | string | 属性名称列表 |
请求示例
POST openapi/face/getFaceInfoItemHTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& num=2&group_name=vip |
返回示例
{ “code”: 0 “data”: { “num”: 3, “name_list”: [ “phone”, “address”, “vip_level” ] }, } |
9. 新增人脸
描述
通过此接口可以向某个特定的人脸分组增加新人脸,并给每个人脸配置相关属性值。一次增加一个人脸。
请求方式
Content-Type为multipart/form-data,并对除文件以外的参数按照签名规则进行签名。
请求地址
https://192.168.0.1/openapi/face/addFace,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否 必须 | 示例 |
faceid | string | 人脸id,64位正整数字符串。若不提供则内部生成 | N | 123456 |
pic | file | jpg/png格式的人脸图片文件,最大分辨率为1920*1080,大小在1MB以内 | Y | 11024.jpg |
group_name | string | 分组名称 | Y | stranger |
age | int | 预置属性,年龄 | N | 14 |
gender | int | 预置属性,性别,0表示未知,1表示男性,2表示女性 | N | 1 |
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 |
注:
1.上面的预置属性是IPC数据库中内置的人脸具备的属性,其他的item1/item2/item3/item4/item5是用户自定义属性,若要使用自定义属性,则要调用2.4.6一节的接口来添加自定义属性,如果用户没有先添加人脸属性,直接在这个接口加上对应属性的key-value,IPC设备是不会处理那些属性的;
2.对于age属性,如果不设定,则会由摄像头自动设置此人的年龄段;
3.对于gender,如果不设定,则会由摄像头自动设置此人的性别。
响应参数
字段名称 | 类型 | 描述 | 示例 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、204、206、208、210、211、220,见错误码的描述 | |
faceid | string | 人脸id | 123456 |
请求示例
POST /openapi/face/addFace HTTP/1.1 Host: 192.168.0.1 Content-Type: multipart/form-data; boundary=————————–962974737227706390007700 Content-Length: 1683 —————————-962974737227706390007700 Content-Disposition: form-data; name=”app_id” mdk923idk —————————-962974737227706390007700 Content-Disposition: form-data; name=”faceid” Vip11024 —————————-962974737227706390007700 Content-Disposition: form-data; name=”random” 289192 —————————-962974737227706390007700 Content-Disposition: form-data; name=”timestamp” 15930292837 —————————-962974737227706390007700 Content-Disposition: form-data; name=”sign” IDKNFLK392038KDS932K —————————-962974737227706390007700 Content-Disposition: form-data; name=”group_name” VIP —————————-962974737227706390007700 Content-Disposition: form-data; name=”age” 21 —————————-962974737227706390007700 Content-Disposition: form-data; name=”gender” 1 —————————-962974737227706390007700 Content-Disposition: form-data; name=”hobby” hiking —————————-962974737227706390007700 Content-Disposition: form-data; name=”vip_level” 2 —————————-962974737227706390007700 Content-Disposition: form-data; name=”weight” 60 —————————-962974737227706390007700 Content-Disposition: form-data; name=”phone_num” 1234 —————————-962974737227706390007700 Content-Disposition: form-data; name=”pic”; filename=”11024.jpg” Content-Type: image/jpeg (图片二进制数据) —————————-962974737227706390007700– |
注:
上述hobby、vip_level、weight、phone_num是用户自定义属性,对应item1/item2/item3/item4,自定义属性可以通过2.4.6一节的接口来添加。添加之后方可使用。
返回示例
{ “code”: 0, “data”: { “faceid”: “123456” } } |
10. 删除人脸
描述
通过此接口可以删除指定人脸分组中的某些人脸。
请求地址
https://192.168.0.1/openapi/face/deleteFace,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
num | int | 删除的人脸数量 | Y | 1 |
group_name | string | 分组名称 | Y | example |
faceid_list | string array | 删除的人脸ID列表 | Y | [“105”] |
响应参数
字段名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、204、211、220,见错误码的描述 |
success_list | string array | 删除成功的人脸ID列表 |
failed_list | string array | 删除失败的人脸ID列表 |
not_exist_list | string array | 不存在的人脸ID列表 |
请求示例
POST openapi/face/deleteFace HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& group_name=VIP&faceid_list=[“000001”, “0000002”]&num=2 |
返回示例
{ “code”: 0, “data”: { “success_list”: [ “000001”, “000002” ], “failed_list”: [], “not_exist_list”: [ “000003” ] } } |
11. 更新人脸
描述
更新指定的人脸信息。
请求地址
https://192.168.0.1/openapi/face/updateFace,192.168.0.1需要替换成实际的IPC地址。
请求方式
Content-Type为multipart/form-data,并对除文件以外的参数按照签名规则进行签名。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
group_name | string | 人脸分组名称 | Y | stranger |
faceid | string | 人脸id,64位正整数字符串 | Y | 123456 |
new_group_name | string | 新人脸分组名称 | N | VIP |
pic | file | jpg/png格式的人脸图片文件,最大分辨率为1920*1080,大小不超过1MB | N | example.jpg |
age | int | 预置属性,年龄 | N | 10 |
gender | int | 性别,可更新为1表示男性、2表示女性 | N | 1 |
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 |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、204、207、208、210、211、220,见错误码的描述 |
请求示例
POST /openapi/face/addFace HTTP/1.1 Host: 192.168.0.1 Content-Type: multipart/form-data; boundary=————————–962974737227706390007700 Content-Length: 1683 —————————-962974737227706390007700 Content-Disposition: form-data; name=”app_id” mdk923idk —————————-962974737227706390007700 Content-Disposition: form-data; name=”random” 289192 —————————-962974737227706390007700 Content-Disposition: form-data; name=”timestamp” 15930292837 —————————-962974737227706390007700 Content-Disposition: form-data; name=”sign” IDKNFLK392038KDS932K —————————-962974737227706390007700 Content-Disposition: form-data; name=”group_name” stranger —————————-962974737227706390007700 Content-Disposition: form-data; name=”facdid” 21 —————————-962974737227706390007700 Content-Disposition: form-data; name=”new_group_name” VIP —————————-962974737227706390007700 Content-Disposition: form-data; name=”hobby” hiking —————————-962974737227706390007700 Content-Disposition: form-data; name=”vip_level” 2 —————————-962974737227706390007700 Content-Disposition: form-data; name=”weight” 60 —————————-962974737227706390007700 Content-Disposition: form-data; name=”phone_num” 1234 —————————-962974737227706390007700– |
注:
上述 hobby、vip_level、weight、phone_num 是用户自定义属性,对应item1/item2/item3/item4,自定义属性可以通过 2.4.6 一节的接口来添加。添加之后方可使用。
返回示例
{ “code”: 0 } |
12. 获取人脸
描述
通过指定人脸ID获取人脸信息。
请求地址
https://192.168.0.1/openapi/face/getFace,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
faceid | string | 人脸ID | Y | 4 |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211,见错误码的描述 |
faceid | string | 人脸ID |
group_name | string | 所在分组名称 |
age | int | 年龄,为空则表示用户没有设置过此人脸的年龄 |
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_count | int | 到达过的总次数 |
arrive_time | int | 最后到达时间戳 |
item1 | string | 自定义属性1,用户添加过才会返回 |
item2 | string | 自定义属性2,用户添加过才会返回 |
item3 | string | 自定义属性3,用户添加过才会返回 |
item4 | string | 自定义属性4,用户添加过才会返回 |
item5 | string | 自定义属性5,用户添加过才会返回 |
请求示例
POST openapi/face/getFace HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& faceid=4 |
返回示例
{ “code”: 0, “data”: { “arrive_time”: 1566215943, “arrive_count”: 2, “faceid”: “4”, “group_name”: “VIP”, “point”: “113”, //自定义属性 “gender”: 1, “age”: 10, “age_range”: 2, “vip_level”: “1”, //自定义属性 “hobby”: “tennis”, //自定义属性 “weight”: “60”, //自定义属性 “height”: “180” //自定义属性 } } |
注:
上述point、hobby、vip_level、weight、height是用户自定义属性,对应item1/item2/item3/item4/itme5,自定义属性可以通过2.4.6一节的接口来添加。添加之后才有返回这些属性。
13. 获取人脸列表
描述
获取指定人脸分组的所有人脸信息。
请求地址
https://192.168.0.1/openapi/face/getFaceList,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
group_name | string | 人脸分组名称 | Y | VIP |
page_num | int | 当前页码,默认值和最小值为1 | N | 4 |
page_size | int | 当前页面条目数,默认为10,范围为[1, 100] | N | 10 |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、211,见错误码的描述 |
total_num | int | 总人脸数量 |
return_num | int | 当前返回人脸数量 |
faceid | string | 人脸ID |
age | int | 年龄,为空则表示用户没有设置过此人脸的年龄 |
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_count | int | 到达过的总次数 |
arrive_time | int | 最后到达时间戳 |
item1 | string | 自定义属性1,用户添加过才会返回 |
item2 | string | 自定义属性2,用户添加过才会返回 |
item3 | string | 自定义属性3,用户添加过才会返回 |
item4 | string | 自定义属性4,用户添加过才会返回 |
item5 | string | 自定义属性5,用户添加过才会返回 |
请求示例
POST openapi/face/getFaceIDList HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& group_name=VIP |
返回示例
{ “code”: 0, “data”: { “total_num”: 2, “num”: 2, “faceid_list”: [ { “arrive_time”: 1566215929, “arrive_count”: 2, “faceid”: “3”, “point”: “113”, //自定义属性 “gender”: 2, “vip_level”: “3”, //自定义属性 “hobby”: “tennis”, //自定义属性 “weight”: “60”, //自定义属性 “height”: “180”, //自定义属性 “age”: 10, “age_range”: 2 }, { “arrive_time”: 1566215998 “arrive_count”: 1 “faceid”: “4”, “point”: “113”, //自定义属性 “gender”: 1, “vip_level”: “1”, //自定义属性 “hobby”: “tennis”, //自定义属性 “weight”: “60”, //自定义属性 “height”: “180”, //自定义属性 “age”: 10, “age_range”: 2 } ] } } |
14. 获取人脸ID列表
描述
获取指定人脸分组所有人脸ID列表。
请求地址
https://192.168.0.1/openapi/face/getFaceIdList,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
group_name | string | 人脸分组名称 | Y | VIP |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、207、211,见错误码的描述 |
total_num | int | 指定人脸分组的人脸总数 |
faceid_list | table | 指定人脸分组的所有人脸ID列表 |
请求示例
POST openapi/face/getFaceIDList HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& group_name=VIP |
返回示例
{
"data": {
"total_num": 30000,
"faceid_list": [
661848208,
661848209,
661848210,
661848211,
661848212,
661848213,
661848214,
661848215,
661848216,
661848217,
661848218
]
},
code: 0
}
15. 获取到达时间最旧的人脸
描述
获取指定人脸分组按到达时间排序最旧的N条人脸信息。
请求地址
https://192.168.0.1/openapi/face/getFaceByArrival,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
group_name | string | 人脸分组名称 | Y | VIP |
num | int | 获取人脸数量,默认值和最小值为1,最大值为10 | N | 2 |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、1、2、3、5、7、207、211,见错误码的描述 |
return_num | int | 当前返回人脸数量 |
faceid | string | 人脸ID |
age | int | 年龄,为空则表示用户没有设置过此人脸的年龄 |
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_count | int | 到达过的总次数 |
arrive_time | int | 最后到达时间戳 |
item1 | string | 自定义属性1,用户添加过才会返回 |
item2 | string | 自定义属性2,用户添加过才会返回 |
item3 | string | 自定义属性3,用户添加过才会返回 |
item4 | string | 自定义属性4,用户添加过才会返回 |
item5 | string | 自定义属性5,用户添加过才会返回 |
请求示例
POST openapi/face/getFaceByArrival HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& group_name=VIP&num=2 |
返回示例
{ “code”: 0, “data”: { “return_num”: 2, “faceid_list”: [ { “faceid”: “8”, “arrive_time”: 1566215929, “arrive_count”: 7, “age_range”: 5, “gender”: 1, “age”: 0, “item1”:value1, //自定义属性 “item2”:value2, //自定义属性 “item3”:value3, //自定义属性 “item4”:value4, //自定义属性 “item5”:value5 //自定义属性 }, { “faceid”: “10”, “arrive_time”: 1566110525, “arrive_count”: 6, “age_range”: 4, “gender”: 2, “age”: 0, “item1”: value1, //自定义属性 “item2”:value2, //自定义属性 “item3”:value3, //自定义属性 “item4”:value4, //自定义属性 “item5”:value5 //自定义属性 } ] } } |
16. 清空指定人脸分组
描述
清空指定人脸分组内的所有人脸信息。
请求地址
https://192.168.0.1/openapi/face/ cleanFaceGroup ,192.168.0.1需要替换成实际的IPC地址。
请求参数
这里只列出接口的私有参数,公共参数见公共参数一节描述。
参数名称 | 类型 | 描述 | 是否必须 | 示例 |
group_name | string | 人脸分组名称 | Y | VIP |
响应参数
参数名称 | 类型 | 描述 |
code | int | 返回码,表示操作的结果; 本接口返回码有:0、2、3、12、13、204、220,见错误码的描述 |
请求示例
POST openapi/face/cleanFaceGroup HTTP/1.1 Host: 192.168.0.1 Content-Type: application/x-www-form-urlencoded app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& group_name=VIP&num=2 |
返回示例
{ “code”: 0 } |