用戶管理
用戶組管理
支持四種類型的用戶組：業主、物業、訪客和黑名單。小區完成申請后，會自動添加四個不同類型的分組，通過查詢接口可以查詢到。
四個自動添加的分組名稱為：業主、物業、訪客和黑名單。刪除時，四個默認的用戶組是不能刪掉的。
增加的住戶會自動添加到業主組里。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 |
出參
無