4. AI呵护API

API列表

编号	API名称	路径	版本
4.1	AI呵护服务状态查看	/ai/scene/care/state/query	1.0
4.2	AI呵护服务状态更新（开通服务）	/ai/scene/care/state/update	1.0
4.3	AI呵护人员列表(个人)	/ai/scene/care/member/query/list/i	1.0
4.4	AI呵护人员添加	/ai/scene/care/member/add	1.0
4.5	AI呵护人员移除	/ai/scene/care/member/remove	1.0
4.6	AI呵护人员使能	/ai/scene/care/member/able	1.0
4.7	AI呵护人员查看	/ai/scene/care/member/query/info	1.0
4.8	AI呵护人员列表(全局)	/ai/scene/care/member/query/list	1.0
4.9	AI呵护人员编辑	/ai/scene/care/member/update	1.0

API调用

4.1: AI呵护状态查看

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/state/query

方法：POST

请求参数

名称	位置	类型	必填	描述
communityId	BODY	STRING	是	项目id
userId	BODY	STRING	是	用户id（head获取）

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

{
  "communityId": 21291194
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
enable	data	INT	是	是否开通

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
     "enable":1
  }
}

4.2: AI呵护状态更新(开通服务)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/state/update

方法：POST

请求参数

名称	位置	类型	必填	描述
communityId	BODY	STRING	是	项目id
userId	BODY	STRING	是	用户id（head获取）

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

{
  "communityId": 21291194
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.3: AI呵护成员列表(个人)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/member/query/list/i

方法：POST

请求参数

名称	位置	类型	必填	描述
communityId	BODY	LONG	是	项目id
userId	BODY	LONG	是	用户id（head获取）
pageNo	BODY	INTEGER	否	页码
pageSize	BODY	INTEGER	否	每页数量

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

{
  "communityId": 21291194
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
members	data	JSONARRAY	是	成员组
personBizId	members	STRING	是	自然人业务ID
personBizType	members	INT	是	自然人业务类型： 1:住户;2:访客;3:员工;4:其他
personBizName	members	STRING	是	自然人业务名称
personTag	members	STRING	是	自然人标签，child, oldman, special
personAttr	members	STRING	是	自然人
faceId	members	STRING	是	人脸ID
imageUrl	members	STRING	是	输入图像URL
able	members	INT	是	1.启用，0.暂停
takerList	members	STRING	是	看护人数组

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
       "members":[{
        "personBizId": "",
        "personBizType": 1,
        "personBizName": "",
        "personTag": "",
        "personAttr": {
          "age": 12, //年龄
          "sex": 1, //1男、2女
          "tel": "", //电话
        },
        "faceId": "",
        "imageUrl": "",
        "able": 1,
        "takerList":[{
          "personBizId": "",
          "personBizName": "",
          "personBizType": 1,
                "relTypeCode": "",
                "relTypeName": ""
        }]
    }]
  }
}

4.4: AI呵护成员添加

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/member/add

方法：POST

请求参数

名称	位置	类型	必填	描述
communityId	BODY	STRING	是	项目id
userId	BODY	STRING	是	用户id（head获取）
personBizId	members	STRING	是	自然人业务ID
personBizType	members	INT	是	自然人业务类型： 1:住户;2:访客;3:员工;4:其他
personTag	members	STRING	是	自然人标签，child, oldman, special
faceId	members	STRING	是	人脸ID
imageUrl	members	STRING	是	输入图像URL
takerList	members	STRING	否	看护人数组
personBizId	takerList	STRING	否	看护人业务ID
personBizType	takerList	STRING	否	看护人类型
personBizName	takerList	STRING	否	看护人名称
relTypeCode	takerList	STRING	否	看护人关系(代号)
relTypeName	takerList	STRING	否	看护人关系(名称)

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

{
  "communityId": 21291194
  "personBizId": "",
  "personBizType": 1,
  "personBizName": "",
  "personTag": "",
  "faceId": "",
  "imageUrl": "",
  "takerList":[{
    "personBizId": "",
    "personBizType": 1,
    "personBizName": "",
    "relTypeCode": "",
    "relTypeName": ""
  }]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.5: AI呵护成员删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/member/remove

方法：POST

请求参数

名称	位置	类型	必填	描述
memberId	BODY	LONG	是	呵护成员id

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

{
  "memberId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.6: AI呵护成员使能

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/member/able

方法：POST

请求参数

名称	位置	类型	必填	描述
memberId	BODY	LONG	是	呵护成员id
able	members	INT	是	1.启用，0.暂停

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

{
  "memberId": 1,
  "able": 1
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.7: AI呵护成员查看

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/member/query/info

方法：POST

请求参数

名称	位置	类型	必填	描述
memberId	body	LONG	是	呵护人员id

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

{
  "memberId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
personBizId	members	STRING	是	自然人业务ID
personBizType	members	INT	是	自然人业务类型： 1:住户;2:访客;3:员工;4:其他
personBizName	members	STRING	是	自然人业务名称
personTag	members	STRING	是	自然人标签，child, oldman, special
faceId	members	STRING	是	人脸ID
imageUrl	members	STRING	是	输入图像URL
able	members	INT	是	1.启用，0.暂停
takerList	members	STRING	是	看护人数组

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
        "personBizId": "",
        "personBizType": 1,
        "personBizName": "",
        "personTag": "",
        "faceId": "",
        "imageUrl": "",
        "able": 1,
        "takerList":[{
          "personBizId": "",
          "personBizName": "",
          "personBizType": 1,
                "relTypeCode": "",
                "relTypeName": ""
        }]
  }
}

4.8: AI呵护成员列表(全局)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/member/query/list

方法：POST

请求参数

名称	位置	类型	必填	描述
pageSize	BODY	STRING	是	每页数量
pageNo	BODY	STRING	是	第几页
communityId	BODY	LONG	否	项目id
personTag	BODY	STRING	否	人物标签
able	BODY	INTEGER	否	开启状态
personBizName	BODY	STRING	否	呵护对象名称（搜索）

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

{
    "pageSize": 10,
    "pageNo": 0,
    "communityId": 21291201,
    "personTag":"child",
    "able":0,
    "personBizName":"xxx"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
members	data	JSONARRAY	是	成员组
bizTypeCode	members	STRING	是	业务类型: Project
bizInstId	members	STRING	是	业务实例ID
bizInstName	members	STRING	是	业务实例名称
bizInstHouseId	members	STRING	是	房屋ID
bizInstHouseName	members	STRING	是	房屋名称
personBizId	members	STRING	是	自然人业务ID
personBizType	members	INT	是	自然人业务类型： 1:住户;2:访客;3:员工;4:其他
personBizName	members	STRING	是	自然人业务名称
personTag	members	STRING	是	自然人标签，child, oldman, special
personAttr	members	STRING	是	自然人属性
faceId	members	STRING	是	人脸ID
imageUrl	members	STRING	是	输入图像URL
able	members	INT	是	1.启用，0.暂停
takerList	members	STRING	是	看护人数组

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
       "members":[{
        "bizTypeCode": "",
        "bizInstId": "",
        "bizInstName": "",
        "bizInstHouseId": "",
        "bizInstHouseName": "",
        "personBizId": "",
        "personBizType": 1,
        "personBizName": "",
        "personTag": "",
          "age": 12, //年龄
          "sex": 1, //1男、2女
          "tel": "", //电话
        "faceId": "",
        "imageUrl": "",
        "able": 1,
        "takerList":[{
          "personBizId": "",
          "personBizName": "",
          "personBizType": 1,
          "personContactPhone": "",
                "relTypeCode": "",
                "relTypeName": ""
        }]
    }]
  }
}

4.9: AI呵护成员编辑

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/ai/scene/care/member/update

方法：POST

请求参数

名称	位置	类型	必填	描述
memberId	BODY	STRING	是	看护对象ID
takerList	members	STRING	否	看护人数组
personBizId	takerList	STRING	否	看护人业务ID
personBizType	takerList	STRING	否	看护人类型
personBizName	takerList	STRING	否	看护人名称
relTypeCode	takerList	STRING	否	看护人关系(代号)
relTypeName	takerList	STRING	否	看护人关系(名称)

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

{
  "memberId": 21291194,
  "takerList":[{
    "personBizId": "",
    "personBizType": 1,
    "personBizName": "",
    "relTypeCode": "",
    "relTypeName": ""
  }]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

错误码列表(31001-31099)

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