根据用户id和用户类型查询人脸图片,返回的图片格式支持URL和base64编码。
路径 | /face/paas/image/get |
版本号 | 1.2.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 10000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
userType | String | 是 | 用户类型,与userId共同作为人脸图片的唯一标识,目前支持的取值有:【IDENTITY】用identityId作为userId;【OPEN】OA三方账号体系;【YUNDUN】云盾自定义用户体系;【PHONE】用手机号作为userId | |
userId | String | 是 | 用户ID | |
imageFormat | String | 否 | 图片数据的返回格式,目前支持URL和BASE64,默认为URL |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
imageUrl | String |
图片URL |
|
imageBase64 | String |
图片base64数据 |
|
faceId | String |
人脸ID |
|
userId | String |
用户ID |
|
userType | String |
用户类型 |
|
userName | String |
用户名称 |
|
expireTime | String |
过期时间 |
|
policy | String |
通行策略 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.2.0"
},
"params":{
"userType": "value0",
"userId": "value1",
"imageFormat": "value2"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"imageUrl":"http://yyy/1.jpg",
"faceId":"xxx",
"userId":"xxx",
"userType":"PHONE",
"userName":"xxx",
"expireTime":"yyyy-MM-dd HH:mm:ss",
"policy":"PERMISSION"
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
错误码
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 | 2459 | oa error message | 会话Id不存在 |
200 | 2459 | oa error message | 会话Id不存在 |
200 | 460 | iotToken is blank | iotToken为空 |
200 | 2402 | iottoken invalid | iottoken已经失效 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 2453 | app not exist | appkey不存在 |
200 | 2405 | identity is not existed | 统一身份id不存在 |
200 | 2407 | auth identity exception | 不存在相应的openId |
200 | 403 | request forbidden | 访问被禁止 |
200 | 460 | dingdingbind employee not exist | 请求参数错误 |
200 | 2442 | employee is not exist | 未找到绑定的员工信息 |
200 | 403 | request forbidden | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 2407 | openId invalid | openId invalid |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden | 请求被禁止 |
200 | 460 | pageSize should between 1-50 | 每页的数量在1-50之间 |
200 | 460 | pageSize should between 1-100 | 每页数量在1-100之间 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 20008 | token invalid | token已失效 |
200 | 460 | identityId is blank | 冻结的账号不存在 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | identityIds need between 1-50 | 入参错误 |
200 | 460 | identityId is blank | 冻结的账号不存在 |
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 | 3001 | role not exist | 角色不存在 |
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 | 3001 | role not exist | 角色不存在 |
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 | 3000 | permission not exist | 权限不存在 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 3002 | resource not exist | 资源不存在 |
200 | 500 | server error. | 服务端异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 460 | request parameter error. | 请求参数异常 |
200 | 500 | server error. | 服务端异常 |
在文档使用中是否遇到以下问题
更多建议
匿名提交