全部产品
云市场

客流用户管理服务

更新时间:2020-02-12 09:42:29

前言

客流用户管理服务,主要是基于AIoT慧眼通客流分析软硬一体的解决方案,帮助客户从简单的计人数到添加用户与管理,帮助客户通过视频技术识别场内用户身份,从而提升线下场景运营效率。流程图

方案1,当摄像头具备一定的智能算法,比如人脸抓怕、客流统计等,可以直接继承IoT LinkVisual SDK的摄像头, 将智能事件和图片上报给IoT平台,并通过慧眼通客流分析算法做进一步分析处理。

方案2,如果摄像头本身不具备智能运算的能力,可以使用IoT一方产品AI-BOX,将摄像头视频流(支持GB28181/海康/大华/宇视等协议)处理后主动上报。

接口文档

1、用户管理

1.1 查询底库上传地址(最多10条)

路径:/home/face/file/getuploadurl
版本:1.0.0

  1. 入参:
  2. {
  3. "batch": 10 // 非必填,批量个数,小于等于10,可一次请求多个URL
  4. }
  5. 出参:
  6. {
  7. "code": 200,
  8. "message": "success",
  9. "data":[
  10. {
  11. "faceKey":"xxx", // oss文件名
  12. "faceUrl":"http://oss-example.oss-cn-hangzhou.aliyuncs.com/xxx.jpg" // oss文件URL
  13. },
  14. {
  15. "faceKey":"xxx",
  16. "faceUrl":"http://oss-example.oss-cn-hangzhou.aliyuncs.com/xxx.jpg"
  17. }
  18. ]
  19. }

1.2批量添加用户(最多10条/批)

路径:/home/face/user/batchadd
版本:1.0.0

  1. 入参:
  2. userList:[
  3. {
  4. "name": "xxx", // 必填,姓名
  5. "gender": "F", // 必填,性别: F-女,M-男
  6. "age": 10, // 必填,年龄
  7. "faceKey": "xxx", // 非必填,oss人脸图片名称
  8. "faceType": 1 // 必填,0-白名单,1-黑名单
  9. }
  10. ]

出参

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data":[{
  5. "name": "晓筑",
  6. "identityId": "xxx",
  7. "status": true // true-创建成,false-创建失败
  8. },{
  9. "name": "晓筑1",
  10. "identityId": "xxx",
  11. "status": false
  12. }]
  13. }

1.3 查询用户

路径:/home/home/face/user/get
版本:1.0.0

参数 类型 是否必填 备注
identityId String 用户ID

入参

  1. {
  2. "identityId": "xxx",
  3. }

出参

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": {
  5. "name": "xxx",
  6. "gender": "F",
  7. "age": 10,
  8. "faceId": "xxx", // faceKey二选一
  9. "faceKey": "xxx", // 人脸底库在oss的名字
  10. "faceType": 1 // 0-白名单、1-黑名单
  11. }

1.4 分页查询用户

路径:/home/face/user/querybypage
版本:1.0.0

  1. 入参:
  2. {
  3. "pageNo": 1, // 必填
  4. "pageSize": 10, // 必填
  5. "faceType": 0 // 非必填,0-白名单、1-黑名单
  6. }
  7. 出参:
  8. {
  9. "code": 200,
  10. "message": "success",
  11. "data": {
  12. "tatal": 10,
  13. "pageNo": 1,
  14. "pageSize": 10,
  15. "data":[{
  16. "identityId": "xxx",
  17. "name": "xxx",
  18. "gender": "F",
  19. "age": 10,
  20. "faceId": "xxx", // faceKey二选一
  21. "faceKey": "xxx", // 人脸底库在oss的名字
  22. "faceType": 1 // 0-白名单、1-黑名单
  23. }]
  24. }

1.5 更新用户

路径:/home/face/user/update
版本:1.0.0

  1. 入参:
  2. {
  3. "identityId": "xxx", // 必填,用户身份ID
  4. "name": "xxx", // 非必填,所有非必填字段不能同时为空,姓名
  5. "gender": "F", // 非必填,所有非必填字段不能同时为空,性别: F-女,M-男
  6. "age": 10, // 非必填,所有非必填字段不能同时为空,年龄
  7. "faceKey": "xxx", // 非必填,所有非必填字段不能同时为空,人脸底库在oss的名字
  8. "faceType": 1 // 非必填,所有非必填字段不能同时为空,0-白名单、1-黑名单
  9. }
  10. 出参:
  11. {
  12. "code": 200,
  13. "message": "success",
  14. "data": null
  15. }

1.6 批量删除用户

路径:/home/face/user/batchdelete
版本:1.0.0

  1. 入参:
  2. identityIds:[
  3. "xxx","xxx" // 必填,人员身份ID列表,List<identityId>
  4. ]
  5. 出参:
  6. {
  7. "code": 200,
  8. "message": "success",
  9. "data": null
  10. }

2、匿名客人管理

这里的匿名客人并不是没有名字的客人,指的是经常在商场出现,缺不在黑白名单中的客人。主要用于客户分析,促进转化率,比如一个客人在近15天内每天都出现,但不是商场的会员,这种是潜在可以发展成会员的客人。

2.1 查询匿名人脸

匿名人脸:摄像头直接抓拍的人脸图片,如果没有绑定用户,就是匿名人脸。该接口用于查询某段时间内出现次数超过阈值caputuredNum的匿名人脸。可以通过绑定接口把匿名人脸绑定到用户下。

路径:/home/face/anonymous/face/query
版本:1.0.0

入参
参数 类型 是否必填 备注
toDate String 格式yyyy-MM-dd,结束日期(含当天),默认昨天
period String 时间段枚举,相对toDate,YESTODAY-昨天,LAST7DAY-近7天,LAST15DAY-近15天,LAST30DAY-近30天,LAST60DAY-近60天,LAST90DAY-近90天
capturedNum Integer 抓拍的次数,YESTODAY 表示一天内抓拍的次数,其他表示抓拍的天数
pageNo Integer 页码
pageSize Integer 分页大小

出参
参数 类型 备注
faceId String 匿名人脸Id
faceUrl String 人脸图片地址

示例

入参示例

  1. {
  2. "period":"LAST90DAY",
  3. "toDate":"2019-11-16",
  4. "campturedLimit":15,
  5. "pageNo":1,
  6. "pageSize":10
  7. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": {
  5. "total":200,
  6. "pageNo":1,
  7. "pageSize":10,
  8. "data":[{
  9. "faceId":"xxx",
  10. "faceUrl":"http://xxx.x"
  11. }]
  12. }
  13. }

2.2 查询匿名人脸的抓拍记录

路径:/home/face/anonymous/face/record/query
版本:1.0.0

入参
参数 类型 是否必填 备注
fromTime Long 时间戳,精确到ms
toTime Long 时间戳,精确到ms
faceId String 匿名人脸Id
pageNo Integer 页码
pageSize Integer 分页大小

出参
参数 类型 备注
faceId String 匿名人脸Id
faceUrl String 人脸图片地址
iotId String 设备Id
caputuredTime Date 抓拍时间

示例

入参示例

  1. {
  2. "fromDate":1578053781000,
  3. "toDate":1578056781000,
  4. "faceId":"xxxxx",
  5. "pageNo":1,
  6. "pageSize":10
  7. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": {
  5. "total":200,
  6. "pageNo":1,
  7. "pageSize":10,
  8. "data":[{
  9. "faceId":"xxx",
  10. "faceUrl":"http://xxx.x",
  11. "iotId":"xxxx",
  12. "capturedTime":1578053781000
  13. }]
  14. }
  15. }

3、用户与人脸关联管理

因为对准确率要求不同,以及现实条件限制等因素,一个人可能会被识别成几个人拥有几个faceId,可以通过

3.1 查询用户绑定的人脸

路径:/home/face/user/face/query
版本:1.0.0

入参
参数 类型 是否必填 备注
identityId String 用户Id

出参
参数 类型 备注
identityId String 用户Id
faceId String 人脸Id
faceUrl String 人脸图片地址
gmtCreate Data 添加时间

示例

入参示例

  1. {
  2. "identityId":"xxxxx",
  3. "faceIds":["yyyy","zzzz"]
  4. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": [
  5. {
  6. "identityId":"",
  7. "faceId":"",
  8. "faceUrl":"",
  9. "gmtCreate":1578053761000
  10. },
  11. {
  12. "identityId":"",
  13. "faceId":"",
  14. "faceUrl":"",
  15. "gmtCreate":1578053781000
  16. }
  17. ]
  18. }

3.2 添加匿名人脸到用户

路径:/home/face/user/face/bind
版本:1.0.0

入参
参数 类型 是否必填 备注
faceIds JSON 人脸Id
identityId String 用户Id

出参
参数 类型 备注
data Integer 成功绑定的个数

示例

入参示例

  1. {
  2. "identityId":"xxxxx",
  3. "faceIds":["yyyy","zzzz"]
  4. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": 2
  5. }

3.3 删除用户的人脸

路径:/home/face/user/face/unbind
版本:1.0.0

入参
参数 类型 是否必填 备注
faceIds JSON 人脸Id
identityId String 用户Id

出参
参数 类型 备注
data Integer 成功删除的个数

示例

入参示例

  1. {
  2. "identityId":"xxxxx",
  3. "faceIds":["yyyy","zzzz"]
  4. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": 2
  5. }