获取部门用户详情信息列表
根据部门ID获取部门内所有用户的详细信息列表,支持分页查询。
请求格式说明
请求方式: GET (HTTPS)
请求地址: https://open.welink.huaweicloud.com/api/contact/v1/user/users
认证方式: access_token,请参考获取access_token。
请求头部:
Accept-Charset:UTF-8
Content-Type:application/json
x-wlk-Authorization:access_token
请求参数说明:
参数名 | 参数说明 | 类型 | 必选 |
---|---|---|---|
deptCode | 部门编码。从用户详细信息中获取部门编码 | string | 是 |
pageNo | 当前页数。默认为1 | string | 否 |
pageSize | 每页显示数量。默认为10(不能大于50) | string | 否 |
请求示例:
curl -X GET "https://open.welink.huaweicloud.com/api/contact/v1/user/users?deptCode=3003" -H "Accept-Charset: utf-8" -H "x-wlk-Authorization: access_token"
响应格式说明
正常返回结果
{
"code": 0,
"message": "OK",
"pageNo": 1,
"pages": 1,
"pageSize": "10",
"total": 2,
"data": [{
"userStatus": "1", //状态, 1:未开户,2:开户中,3:已开户,4:已销户
"userId": "zhangsan1@welink", //用户帐号, Key值
"deptCode": "10001", //部门Id, Key值, 必填
"deptNameCn": "72270测试部门",
"deptNameEn": "72270Test Dept",
"mobileNumber": "+86-15811847236", //绑定手机号码, 必填
"phoneNumber": "+86-15811847236", //手机号码
"landlineNumber": "0755-88888888", //电话号码(座机)
"userNameCn": "张三", //用户中文名称, 必填
"userNameEn": "zhangshan", //用户英文名称, 必填
"sex": "M", //性别, 仅:M/F, M: 男, F: 女, 必填
"corpUserId": "36188", //用户工号(集成用的字段,如果在开户时没有维护则为空)
"userEmail": "zhangshan4@126.com", //用户邮箱, 必填
"secretary": "zhangshan@welink", //秘书(用户帐号)
"address": "广东省深圳", //地址
"remark": "欢迎加入WeLink", //备注
"creationTime": "2018-05-03 13:58:02", //创建时间
"lastUpdatedTime": "2018-05-03 13:58:02" //最后更新时间
},
{
"userStatus": "1", //状态, 1:未开户2:开户中3:已开户4已销户
"userId": "zhangsan1@welink", //用户帐号, Key值
"deptCode": "10001", //部门Id, Key值, 必填
"deptNameCn": "72270测试部门",
"deptNameEn": "72270Test Dept",
"mobileNumber": "+86-15811847236", //绑定手机号码, 必填
"phoneNumber": "+86-15811847236", //手机号码
"landlineNumber": "0755-88888888", //电话号码(座机)
"userNameCn": "张三", //用户中文名称, 必填
"userNameEn": "zhangshan", //用户英文名称, 必填
"sex": "M", //性别, 仅:M/F, M: 男, F: 女, 必填
"corpUserId": "36188", //用户工号(集成用的字段,如果在开户时没有维护则为空)
"userEmail": "zhangshan4@126.com", //用户邮箱, 必填
"secretary": "zhangshan@welink", //秘书(用户帐号)
"address": "广东省深圳", //地址
"remark": "欢迎加入WeLink", //备注
"creationTime": "2018-05-03 13:58:02", //创建时间
"lastUpdatedTime": "2018-05-03 13:58:02" //最后更新时间
}
]
}
异常返回结果
{
"code": 47101,
"message": "Token格式错误",
"data": []
}
返回参数说明:
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
code | 是 | int | 数据正常返回“0”,如果发生错误,会返回对应的错误码 |
message | 是 | string | 返回信息,包括接口请求发生错误时的详细信息 |
pageNo | 是 | int | 当前页数 |
pages | 是 | int | 总共页数 |
pageSize | 是 | string | 每页显示数量 |
total | 是 | int | 总数量 |
data | 否 | array | 用户信息: >> userStatus: 状态 >> userId: 用户账号 >> deptCode : 部门编码 >> deptNameCn : 部门中文名称 >> deptNameEn : 部门英文名称 >> mobileNumber : 绑定手机号码 >> phoneNumber: 手机号码 >> landlineNumber: 电话号码(座机) >> userNameCn: 用户中文名称 >> userNameEn: 用户英文名称 >> sex : 性别 >> corpUserId: 员工工号(企业内唯一标识) >> userEmail: 邮箱 >> secretary: 秘书(用户帐号) >> address: 地址 >> remark: 备注 >> creationTime: 创建时间 >> lastUpdatedTime: 最后更新时间 |
错误码说明:
错误码 | 说明 |
---|---|
47000 | 无权限 |
47001 | 当前登录用户信息获取失败 |
47002 | 部门编码为空 |
47003 | 参数为空 |
47004 | 参数不对 |
47007 | 当前登录者是非法用户或个人详情已失效 |
47008 | 参数校验不通过 |
47009 | 提交失败 |
47012 | 无数据 |
47013 | 查询数量限制 |
47100 | 待处理 |
47101 | Token格式错误 |
47102 | 无权限 |
47103 | Token过期 |
47104 | 处理中 |
47105 | 秘书账号未创建 |
47106 | 上级部门未创建 |
500 | 系统错误 |