1. 人脸API

API列表

编号 API名称 路径 版本
1.1 人脸检测 /ai/face/detect 1.0
1.2 人脸保存 /ai/face/save 1.0
1.3 人脸删除 /ai/face/remove 1.0
1.4 人脸查询 /ai/face/query 1.0
1.5 人脸详情 /ai/face/query/info 1.0
1.6 人脸同步(linkface) /ai/face/sync/linkface
1.7 人脸分组列表 /ai/face/group/query/list 1.0
1.8 人脸分组创建 /ai/face/group/create
1.9 人脸分组删除 /ai/face/group/delete 1.0

API调用

1.1: 人脸检测

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/face/detect

方法：POST

请求参数

名称 位置 类型 必填 描述
imageType BODY INT 是 0: 通过url识别参数，参数image_url不为空
1: 通过图片content识别，参数content不为空
imageUrl BODY STRING 否 输入图像URL
imageContent BODY STRING 否 图像内容，base64编码

请求Body描述(非Form表单数据)

{
  "imageType": 0,
  "imageUrl": "",
  "imageContent": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.2: 人脸保存

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/face/save

方法：POST

请求参数

名称 位置 类型 必填 描述
bizTypeCode BODY STRING 是 业务类型: Project
bizInstId BODY STRING 是 业务实例ID
personBizId BODY STRING 否 自然人业务ID
personBizName BODY STRING 是 自然人业务名称
personBizType BODY INT 是 自然人业务类型：
1:住户;2:访客;3:员工;4:其他
personTag BODY STRING 否 自然人标签，child, oldman, special
personAttr BODY JSONObject 否 自然人属性
imageType BODY INT 是 0: 通过url识别参数，参数image_url不为空
1: 通过图片content识别，参数content不为空
imageUrl BODY STRING 否 输入图像URL
imageContent BODY STRING 否 图像内容，base64编码
submitter_name BODY STRING 否 添加人名字

请求Body描述(非Form表单数据)

{
  "bizTypeCode": "Project", //项目代号
  "bizInstId": "20781234", //项目ID
  "personBizName": "", //业务人名称
  "personBizType": 1, //业务人类型
  "personTag": "", //业务人标签
  "personAttr": {
    "age": 12, //年龄
    "sex": 1, //1男、2女
    "tel": "", //电话
    "idcard": "", //身份证
    "custType": "", //1001业主成员 2001租户成员
    "houseId":"" //房屋ID
  },
  "imageType": "",
  "imageUrl": "",
  "imageContent": "",
  "submitter_name": "aaa"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
faceId data String 是 人脸ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "faceId": "",
      "personBizId": ""
  }
}

1.3: 人脸删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/face/remove

方法：POST

请求参数

名称 位置 类型 必填 描述
bizTypeCode BODY STRING 是 业务类型: Project
bizInstId BODY STRING 是 业务实例ID
faceId BODY STREING 是 人脸ID
imageUrl BODY STREING 是 图片

请求Body描述(非Form表单数据)

{
  "bizTypeCode": "Project",
  "bizInstId": "20781234",
  "faceId": "",
  "imageUrl": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.4: 人脸列表查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/face/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
bizTypeCode BODY STRING 否 业务类型: Project
bizInstId BODY STRING 否 业务实例ID

请求Body描述(非Form表单数据)

{
  "bizTypeCode": "Project",
  "bizInstId": "20781234"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
faces data JSONARRAY 是 人脸列表
faceId faces STRING 是 人脸ID
personBizId faces STRING 否 自然人业务ID
personBizName faces STRING 是 自然人业务名称
personBizType faces INT 是 自然人业务类型：
1:业主;2:业主成员;3:租户;4:租户成员;5:员工;6访客;7特殊访客
imageUrl faces STRING 否 输入图像URL
houseId faces STRING 是
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
    "faces":[
      "faceId": "",
      "personBizType": 1,
      "personBizId": "",
      "personBizName": "",
      "imageUrl": "",
      "houseId": ""
      ]
  }
}

1.5: 人脸信息查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/face/query/info

方法：POST

请求参数

名称 位置 类型 必填 描述
bizTypeCode BODY STRING 是 业务类型: Project
bizInstId BODY STRING 是 业务实例ID
personBizType BODY STRING 是 自然人业务类型：
1:业主;2:业主成员;3:租户;4:租户成员;5:员工;6访客;7特殊访客
personBizId BODY STRING 是 自然人业务ID
faceId BODY STRING 否 人脸ID

请求Body描述(非Form表单数据)

{
  "bizTypeCode": "Project",
  "bizInstId": "20781234",
  "personBizType": 1,
  "personBizId": "",
  "faceId": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
personBizName data STRING 是 自然人业务名称
personTag data STRING 否 自然人标签，child, oldman, special
personAttr data STRING 否 自然人属性
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
    "personBizName": "", //业务人名称
    "personTag": "", //业务人标签
    "personAttr": {
      "age": 12, //年龄
      "sex": 1, //1男、2女
      "tel": "", //电话
      "idcard": "" //身份证
    }
  }
}

1.6: 人脸同步(linkface)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/face/sync/linkface

方法：POST

请求参数

名称 位置 类型 必填 描述
bizTypeCode BODY STRING 是 业务类型: Project
bizInstId BODY STRING 是 业务实例ID
personBizId BODY STRING 否 自然人业务ID
personBizName BODY STRING 是 自然人业务名称
personBizType BODY INT 是 自然人业务类型：
1:业主;2:业主成员;3:租户;4:租户成员;5:员工;6访客;7特殊访客
imageUrl BODY STRING 否 输入图像URL

请求Body描述(非Form表单数据)

{
  "bizTypeCode": "Project", //项目代号
  "bizInstId": "20781234", //项目ID
  "personBizId": "", //业务人ID
  "personBizName": "", //业务人名称
  "personBizType": 6, //业务人类型
  "imageUrl": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
xFaceId data String 是 人脸ID
xFaceGroup data String 人脸组
xFaceInfo data String 人脸信息
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "xFaceId": "",
      "xFaceGroup": "",
      "xFaceInfo": ""
  }
}

错误码列表(31001-31099)

错误码 错误信息 描述
31001 face detect failure 人脸检测失败
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""