获取用户详细信息
请求用户详细信息的接口,使用用户userId获取用户详细数据。
请求格式说明
请求方式: GET (HTTPS)
请求地址: https://open.welink.huaweicloud.com/api/contact/v1/users
认证方式: access_token,请参考获取access_token。
请求头部:
x-wlk-Authorization: access_token
请求参数:
参数 | 说明 |
---|---|
userId | 用户帐号 |
mobileNumber | 绑定的手机号码 |
corpUserId | 用户工号 |
可通过三个请求参数任意一个获取。
请求示例:
curl -H "x-wlk-Authorization: access_token" https://open.welink.huaweicloud.com/api/contact/v1/users?userId=zhangshan2@cloudlink
响应格式说明
返回结果:
{
"code": "0",
"message": "ok",
"userStatus": "1",
"userId": "zhangshan2@welink",
"deptCode": "10001",
"mobileNumber": "+86-15811847236",
"userNameCn": "张三",
"userNameEn": "zhangshan",
"sex": "M",
"corpUserId": "36188",
"userEmail": "zhangshan4@126.com",
"secretary": "zhangshan@welink",
"phoneNumber": "0755-88888888",
"address": "广东省深圳",
"remark": "欢迎加入WeLink",
"creationTime": "2018-05-03 13:58:02",
"lastUpdatedTime": "2018-05-03 13:58:02",
}
返回参数说明:
参数 | 说明 |
---|---|
code | 数据正常返回“0”,如果发生错误,会返回对应的错误码。 |
message | 返回信息,包括接口请求发生错误时的详细信息。 |
userStatus | 状态, 1:未开户2:开户中3:已开户4已销户 |
userId | 用户帐号, Key值, 必填 |
deptCode | 部门Id, Key值, 必填 |
mobileNumber | 绑定手机号码, 必填 |
userNameCn | 用户中文名称, 必填 |
userNameEn | 用户英文名称, 必填 |
sex | 性别, 仅:M/F, M: 男, F: 女, 必填 |
corpUserId | 用户工号(集成用的字段,如果在开户时没有维护则为空) |
userEmail | 用户邮箱, 必填 |
secretary | 秘书(用户帐号) |
phoneNumber | 电话号码(座机) |
address | 地址 |
remark | 备注 |
creationTime | 创建时间 |
lastUpdatedTime | 最后更新时间 |
错误码说明:
错误码 | 说明 |
---|---|
47001 | 当前登录用户信息获取失败 |
47003 | 参数为空 |
47004 | 仅支持一个参数 |
47005 | 参数输入错误,请按指定值输入 |
500 | 系统错误 |