用户管理
用户组管理
支持四种类型的用户组：业主、物业、访客和黑名单。小区完成申请后，会自动添加四个不同类型的分组，通过查询接口可以查询到。
四个自动添加的分组名称为：业主、物业、访客和黑名单。删除时，四个默认的用户组是不能删掉的。
增加的住户会自动添加到业主组里。ISV也可以创建自定义用户组。
1.1新建用户组
用户组是管理人员的基础单位，用户组中可以添加用户，也可以将用户组中的智能识别下发到AIBOX或者门禁设备中。
Path路径 | /solution/community/paas/user/group/add |
请求方式 | post |
接口版本 | 1.0.1 |
字段名 | 类型 | 必填 | 备注 |
userGroupName | String | 是 | 用户组名称 |
userGroupType | String | 是 | 用户组类型RESIDENT - 居民VISITOR - 访客PROPERTY - 物业BLACKLIST - 黑名单 |
字段名 | 类型 | 备注 |
data | JSON | 用户组ID |
用户组ID
字段名 | 类型 | 备注 |
userGroupId | String | 用户组ID |
1.2更新用户组
更新设备组的名称。
Path路径 | /solution/community/paas/user/group/update |
请求方式 | post |
接口版本 | 1.0.1 |
字段名 | 类型 | 必填 | 备注 |
userGroupName | String | 是 | 用户组名称 |
userGroupId | String | 是 | 用户组ID |
通用网关消息体，无业务字段
1.3删除用户组
用户组布防，是将对应的用户组智能识别同步至边缘AIBOX中，由AIBOX进行人员比对后形成人行数据，后续用户组的用户信息进行变更时，系统会自动进行用户照片的同步。
Path路径 | /solution/community/paas/user/group/delete |
请求方式 | post |
接口版本 | 1.0.1 |
字段名 | 类型 | 必填 | 备注 |
userGroupId | String | 是 | 用户组ID |
通用网关消息体，无业务字段
1.4查询用户组
根据用户组名称查询已有的用户组列表。
Path路径 | /solution/community/paas/user/group/query |
请求方式 | post |
接口版本 | 1.0.1 |
字段名 | 类型 | 必填 | 备注 |
userGroupName | String | 否 | 用户组名称 |
pageNo | Integer | 是 | 页码 |
pageSize | Integer | 是 | 页面数据条数 |
字段名 | 类型 | 备注 |
data | JSONArray | 用户组结构 |
用户组结构
字段名 | 类型 | 备注 |
communityId | Long | 小区ID |
userGroupId | String | 用户组ID |
userGroupType | String | 用户组类型 |
userGroupName | String | 用户组名称 |
isDefault | Integer | 是否系统默认，1-系统创建 0-用户创建，通过7、8、13三章创建的用户都会标识为1-系统创建 |
1.5结构化查询用户信息
根据用户组ID查询组内的用户列表。
Path路径 | /solution/community/paas/user/query |
请求方式 | post |
接口版本 | 1.0.5 |
字段名 | 类型 | 必填 | 备注 |
userGroupId | String | 否 | 用户组ID |
userName | String | 否 | 用户名 |
mobile | String | 否 | 手机号 |
modifiedStart | Long | 否 | 更新起始毫秒时间（含） |
modifiedEnd | Long | 否 | 更新结束毫秒时间（含） |
orderBy | JsonObject | 否 | 详见OrderByDTO 排序规则，默认 gmt_create 降序排列 |
pageNo | Integer | 是 | 页码 |
pageSize | Integer | 是 | 页面数据条数 |
OrderByDTO
字段名 | 类型 | 必填 | 备注 |
columnName | String | 是 | 排序列名，需要direction 配合使用，支持的输入：gmt_create 创建时间gmt_modified 更新时间 |
direction | String | 是 | 排序方向，需要columnName配合使用支持的输入desc 降序 |
字段名 | 类型 | 备注 |
data | JSONArray | 用户结构 |
人员结构
字段名 | 类型 | 备注 |
identityId | String | 用户ID |
faceId | String | 智能识别ID |
userName | String | 用户名 |
faceImageUrl | String | 用户图片地址 |
idNo | String | 身份证号 |
userGroups | JSONArray | 用户组列表 |
age | Integer | 年龄 |
sex | Integer | 性别：1男，2女 |
mobile | String | 电话 |
gmtCreate | Long | 创建时间 |
gmtModified | Long | 更新时间 |
nationality | String | 国家/地区 |
ext | String | 自定义配置信息json结构 |
userGroups详情：
字段名 | 类型 | 备注 |
userGroupId | String | 用户组ID |
userGroupName | String | 用户组名称 |
userGroupType | String | 用户组类型 |
1.6查询用户信息
通过用户ID或智能识别ID查询人员信息
Path路径 | /solution/community/paas/user/get |
请求方式 | post |
接口版本 | 1.0.2 |
字段名 | 类型 | 必填 | 备注 |
identityId | String | 否 | 用户ID |
faceId | String | 否 | 智能识别ID |
字段名 | 类型 | 备注 |
data | JSONObject | 人员结构 |
人员结构
字段名 | 类型 | 备注 |
identityId | String | 用户ID |
faceId | String | 智能识别ID |
userName | String | 用户名 |
faceImageUrl | String | 用户图片地址 |
idNo | String | 身份证号 |
userGroups | JSONArray | 用户组列表 |
age | Integer | 年龄 |
sex | Integer | 性别：1男，2女 |
mobile | String | 电话 |
userGroups详情：
字段名 | 类型 | 备注 |
userGroupId | String | 用户组ID |
userGroupName | String | 用户组名称 |
userGroupType | String | 用户组类型 |
1.7智能识别图片查询用户信息
智能识别检索用户，是通过一张用户的照片来检索用户组中的人员信息
Path路径 | /solution/community/paas/user/getbyimage |
请求方式 | post |
接口版本 | 1.0.1 |
字段名 | 类型 | 必填 | 备注 |
ossFileKey | String | 是 | 智能识别图片地址，OSS文件的KEY |
字段名 | 类型 | 备注 |
data | JSONArray | 人员结构 |
人员结构
字段名 | 类型 | 备注 |
identityId | String | 用户ID |
faceId | String | 智能识别ID |
userName | String | 用户名 |
faceImageUrl | String | 用户图片地址 |
idNo | String | 身份证号 |
userGroups | JSONArray | 用户组列表 |
age | Integer | 年龄 |
sex | Integer | 性别：1男，2女 |
mobile | String | 电话 |
userGroups详情：
字段名 | 类型 | 备注 |
userGroupId | String | 用户组ID |
userGroupName | String | 用户组名称 |
userGroupType | String | 用户组类型 |
用户管理
2.1添加用户
Path路径 | /solution/community/paas/user/add |
请求方式 | post |
接口版本 | 1.0.2 |
字段名 | 类型 | 必填 | 备注 |
userGroupId | String | 是 | 用户组ID |
userName | String | 是 | 用户名 长度不能超过12，且只能包含字母、数字、中文 |
mobile | String | 是 | 手机号 |
idNo | String | 否 | 身份证号码 |
sex | Integer | 否 | 性别：1男，2女 |
age | Integer | 否 | 年龄 |
faceImgUploadId | String | 否 | 智能识别图片上传ID地址。获取uploadId见“获取OSS上传地址”和“保存上传OSS文件”接口。上传bizCode=HOUSEHOLD_FACE |
字段名 | 类型 | 备注 |
data | JSON | 用户ID |
用户ID
字段名 | 类型 | 备注 |
identityId | String | 用户ID |
faceId | String | 用户ID |
2.2修改用户
Path路径 | /solution/community/paas/user/update |
请求方式 | post |
接口版本 | 1.0.2 |
字段名 | 类型 | 必填 | 备注 |
identityId | String | 是 | 用户ID |
userName | String | 否 | 用户名 |
idNo | String | 否 | 身份证号码 |
sex | Integer | 否 | 性别：1男，2女 |
age | Integer | 否 | 年龄 |
faceImgUploadId | String | 否 | 智能识别图片上传ID。获取uploadId见“获取OSS上传地址”和“保存上传OSS文件”接口。上传bizCode=HOUSEHOLD_FACE |
通用网关消息体，无业务字段
2.3用户组添加用户
Path路径 | /solution/community/paas/user/group/member/add |
请求方式 | post |
接口版本 | 1.0.1 |
字段名 | 类型 | 必填 | 备注 |
userGroupId | String | 是 | 用户组ID |
identityId | String | 是 | 用户ID |
通用网关消息体，无业务字段
2.4用户组删除用户
Path路径 | /solution/community/paas/user/group/member/delete |
请求方式 | post |
接口版本 | 1.0.1 |
字段名 | 类型 | 必填 | 备注 |
userGroupId | String | 是 | 用户组ID |
identityId | String | 是 | 用户ID |
通用网关消息体，无业务字段
2.5删除用户人脸
调用此接口后，平台上的用户相关的人脸图都会被删除
Path路径 | /solution/community/paas/user/face/delete |
请求方式 | post |
接口版本 | 1.0.0 |
字段名 | 类型 | 必填 | 备注 |
identityId | String | 是 | 用户ID |
出参
无
2.6 删除用户
调用此接口后，平台上的用户关联的信息会被删除，仅保留identityId。
Path路径 | /solution/community/paas/user/delete |
请求方式 | post |
接口版本 | 1.0.0 |
字段名 | 类型 | 必填 | 备注 |
identityId | String | 是 | 用户ID |
出参
无