保存空间下的用户人脸数据,并将人脸数据和权限下发到设备端。
路径 | /face/paas/face/batchsave |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 20000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
scopeIdList | List | 是 | 人脸信息下发的目标范围:当scopeType=SPACE_ID时,表示空间id列表;当scopeType=IOT_ID时,表示设备iotId列表;每次请求最大列表长度是10 | |
scopeType | String | 是 | 人脸信息下发的目标范围类型:SPACE_ID:将人脸信息下发到空间下的所有设备,目前仅支持根空间;IOT_ID:将人脸信息下发到指定的设备 | |
userFaceList | List | 是 | 用户id列表,每次请求最大列表长度是10 | |
userId | String | 是 | 用户id | |
imageUrl | String | 否 | 图片URL:图片URL和图片base64数据,两者必填其一,优先使用图片URL | |
imageBase64 | String | 否 | 图片base64数据:图片URL和图片base64数据,两者必填其一,优先使用图片URL | |
userInfo | String | 否 | 业务扩展字段,用于透传至设备端实现权限管理 | |
userType | String | 是 | 用户类型,YUNDUN表示实人认证系统自定义用户,其他用户类型待扩展 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码:200表示批量操作全部成功;2002表示批量操作部分成功;2003表示批量操作全部失败;具体操作结果参见data域 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
返回数据 |
|
successCount | Int |
成功下发的人脸信息+目标范围的组合数,例如,要将3个人脸数据下发到4个空间中,则全部成功的情况下successCount=12 |
|
scopeType | String |
人脸信息下发的目标范围类型:SPACE_ID:将人脸信息下发到空间下的所有设备,目前仅支持根空间;IOT_ID:将人脸信息下发到指定的设备 |
|
userType | String |
用户类型,YUNDUN表示实人认证系统自定义用户,其他用户类型待扩展 |
|
batchResultList | JSON |
下发结果列表 |
|
scopeId | String |
人脸信息下发的目标范围:当scopeType=SPACE_ID时,表示空间id;当scopeType=IOT_ID时,表示设备iotId |
|
userId | String |
用户id |
|
result | JSON |
下发结果 |
|
code | Int |
响应码:200表示保存成功 |
|
message | String |
错误提示信息 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"scopeIdList": "value0",
"scopeType": "value1",
"userFaceList": "value2",
"userType": "value3"
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 2402 | iotToken not exist | iottoken不存在 |
200 | 2401 | refreshToken invalid | refreshToken已经失效 |
200 | 460 | identityIds need between 1-50 | 入参错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden | 请求被禁止 |
200 | 460 | pageSize should between 1-100 | 每页的数量在1-100之间 |
200 | 460 | employeeIdList should less than 50 | 每次删除的员工数量不能大于50 |
200 | 2405 | identity is not existed | 账号不存在 |
200 | 2411 | oldpassword check faild | 修改密码异常 |
200 | 2405 | employee is not existed | 身份id不存在 |
200 | 2411 | oldpassword check faild | 老密码校验不通过 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 入参错误 |
200 | 403 | request forbidden | 访问被禁止 |
200 | 460 | dingdingbind employee not exist | 请求参数错误 |
200 | 2442 | employee is not exist | 未找到绑定的员工信息 |
200 | 4020 | invalid smscode | 手机验证码无效 |
200 | 20008 | token invalid | token已失效 |
200 | 460 | pageSize should between 1-100 | 每页数量在1-100之间 |
200 | 460 | employeeIdList should less than 50 | 每次删除的员工数量不能大于50 |
200 | 500 | Bad Request | api不存在 |
200 | 2405 | identity is not existed | 公司未初始化 |
200 | 2441 | employee is already existed | 该手机号对应的员工已经存在 |
200 | 460 | request parameter error. | 入参错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error | 账号不存在 |
200 | 460 | identityId is blank | 需要注销的账号不存在 |
200 | 500 | Bad Request | 调用网关失败 |
200 | 460 | request parameter error | 入参错误 |
200 | 460 | request parameter error. | 入参错误 |
200 | 2465 | phone and email can not be empty at the same time | 手机号和email都为空 |
200 | 460 | identityId is blank | 需要注销的账号不存在 |
200 | 500 | Bad Request | 调用网关失败 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
在文档使用中是否遇到以下问题
更多建议
匿名提交