首页 > 开发指南 > 通讯录管理
查询员工信息
更新时间: 2021-12-08 11:38:00

1. 根据Id查询员工信息

请求说明

请求方式:post+application/json 方式

请求路径:https://open.71360.com/cgi/user/get

参数说明

参数            参数类型            必须            说明            
corpAccessToken            String                        企业应用访问公司合法性凭证           
corpId            String                        开放平台公司帐号            
openUserId            String                        开放平台员工帐号            
showDepartmentIdsDetailboolean如果为true,则会返回员工主属部门(mainDepartmentId)与附属部门(attachingDepartmentIds); 默认值为false

请求包结构体示例:

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "openUserId": "OPEN_USER_ID"
}

返回说明

参数            必须            说明            
errorCode                        返回码            
errorMessage                        对返回码的文本描述内容            
openUserId                        开放平台员工帐号            
account员工账号
name                        员工姓名            
nickName                        员工昵称            
isStop                        员工状态,如果为true,则表示此员工状态为停用,否则,员工状态为启用            
email                        邮箱            
mobile                        手机号            
gender                        员工性别:M(男) F(女)            
position                        员工职位            
profileImageUrl                        头像文件ID            
departmentIds                        员工所属部门及其父部门ID列表            
mainDepartmentId员工主属部门ID
attachingDepartmentIds员工附属部门ID列表
employeeNumber员工编号
hireDate入职日期
birthDate员工生日
startWorkDate参加工作日期
createTime创建时间
leaderId汇报对象

a) 正确的JSON返回结果示例:

{
    "openUserId": "FSUID_XXXXXXXXXXXXXXXXXXX",
    "account": "Andson",
    "name": "Andson",
    "nickName": "Andy",
    "isStop": false,
    "mobile": "18210000000",
    "gender": "M",
    "position": "PM",
    "profileImageUrl": "201502_09_99aa47b5-1f3d-4473-8c02-3d69a6769e57",
    "departmentIds": [
        44,
        13
    ],
    "employeeNumber": "168XXX002",
    "hireDate": "2016/08/31",
    "birthDate": "1989/09/05",
    "startWorkDate": "2008-08-31",
    "createTime": 1504547315500,
    "leaderId": "FSUID_XXXXXXXXXXXXXXXXXX",
    "errorCode": 0,
    "errorMessage": "success"
}

b) 错误的JSON返回示例:

{
    "errorCode": 10001,
    "errorMessage": "the parameter appId is missing"
}

2. 根据昵称查询员工信息

请求说明

请求方式:post+application/json 方式

请求路径:https://open.71360.com/cgi/user/getByNickName

参数说明

参数            参数类型            必须            说明            
corpAccessToken            String            是            企业应用访问公司合法性凭证            
corpId            String            是            开放平台公司帐号            
nickNameString            是            员工昵称        

请求包结构体示例:

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "nickName": "张三"
}

返回说明

参数            必须            说明            
errorCode            是              返回码            
errorMessage            是             对返回码的文本描述内容            
errorDescription           否返回码的中文描述
empList否            返回结果列表        
enterpriseId           否企业ei
openUserId           否开放平台员工账号
account           否员工账号
fullName            否            员工姓名            
name            否            员工昵称            
status否            员工状态           
mobile否            员工手机号           
leaderId           否汇报对象开平账号
telephone           否电话号码
role           否角色
post
           否职位
qq           否qq
email
           否邮箱
gender            否            员工性别:M(男) F(女)            
profileImage否            头像
description否             描述        
weixin否             微信账号
msn否             msn        
extensionNumber否             extensionNumber
mobileSetting否             手机号隐私
workingState否             workingState
isActive否             激活状态
mainDepartmentIds否             主属部门
departmentIds否             所有所属部门(包括主属部门)
departmentAsteriskIds          否   星标部门
employeeAsteriskIds          否星标员工
birthDate          否 生日
hireDate否              入职时间 
empNum否              员工编号          
startWorkDate否              就业时间
stopTime          否  停用时间
createTime          否创建时间
updateTime          否更新时间
nameSpell          否nameSpell
nameOrder          否nameOrder

a) 正确的JSON返回结果示例:

{
    "empList": [
        {
            "enterpriseId": 590079,
            "openUserId": "FSUID_69AF29A7AA695787C90614CDDE0A4968",
            "account": "",
            "fullName": "",
            "name": "张三",
            "status": "NORMAL",
            "mobile": "17328366613",
            "leaderId": "FSUID_6D3F8498206FD5F8B2E0559AED7737E1",
            "telephone": "",
            "role": "DEFAULT",
            "post": "",
            "qq": "",
            "email": "",
            "gender": "M",
            "profileImage": "",
            "description": "",
            "weixin": "12342321111",
            "msn": "",
            "extensionNumber": "",
            "mobileSetting": {
                "mobileStatus": "PUBLIC",
                "departmentIds": [],
                "employeeIds": []
            },
            "workingState": "",
            "isActive": true,
            "mainDepartmentIds": [
                1000
            ],
            "departmentIds": [
                1000
            ],
            "departmentAsteriskIds": [],
            "employeeAsteriskIds": [],
            "birthDate": "",
            "hireDate": "2018-06-27",
            "empNum": "",
            "startWorkDate": "",
            "stopTime": 0,
            "createTime": 1530083843500,
            "updateTime": 1542036068500,
            "nameSpell": "HUANGZHI",
            "nameOrder": "H#BBC6#D6C7"
        }
    ],
    "errorCode": 0,
    "errorMessage": "success",
    "errorDescription": "成功"
}

b) 错误的JSON返回示例:

{
    "errorCode": 20017,
    "errorMessage": "openCorpId not found"
}

3. 根据手机号查询员工信息

请求说明

请求方式:post+application/json 方式

请求路径:https://open.71360.com/cgi/user/getByMobile

参数说明

参数            参数类型            必须            说明            
corpAccessToken            String            是            企业应用访问公司合法性凭证            
corpId            String            是            开放平台公司帐号            
mobileString            是            手机号     

请求包结构体示例:

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "mobile": "155xxxx8765"
}

返回说明

参数            必须            说明            
errorCode            是              返回码            
errorMessage            是             对返回码的文本描述内容            
errorDescription           否返回码的中文描述
empList否            返回结果列表        
enterpriseId           否企业ei
openUserId           否开放平台员工账号
account           否员工账号
fullName            否            员工姓名            
name            否            员工昵称            
status否            员工状态           
mobile否            员工手机号           
leaderId           否汇报对象开平账号
telephone           否电话号码
role           否角色
post
           否职位
qq           否qq
email
           否邮箱
gender            否            员工性别:M(男) F(女)            
profileImage否            头像
description否             描述        
weixin否             微信账号
msn否             msn        
extensionNumber否             extensionNumber
mobileSetting否             手机号隐私
workingState否             workingState
isActive否             激活状态
mainDepartmentIds否             主属部门
departmentIds否             所有所属部门(包括主属部门)
departmentAsteriskIds          否   星标部门
employeeAsteriskIds          否星标员工
birthDate          否 生日
hireDate否              入职时间 
empNum否              员工编号          
startWorkDate否              就业时间
stopTime          否  停用时间
createTime          否创建时间
updateTime          否更新时间
nameSpell          否nameSpell
nameOrder          否nameOrder

a) 正确的JSON返回结果示例:

{
    "empList": [
        {
            "enterpriseId": 590079,
            "openUserId": "FSUID_69AF29A7AA695787C90614CDDE0A4968",
            "account": "",
            "fullName": "",
            "name": "张三",
            "status": "NORMAL",
            "mobile": "17328366613",
            "leaderId": "FSUID_6D3F8498206FD5F8B2E0559AED7737E1",
            "telephone": "",
            "role": "DEFAULT",
            "post": "",
            "qq": "",
            "email": "",
            "gender": "M",
            "profileImage": "",
            "description": "",
            "weixin": "12342321111",
            "msn": "",
            "extensionNumber": "",
            "mobileSetting": {
                "mobileStatus": "PUBLIC",
                "departmentIds": [],
                "employeeIds": []
            },
            "workingState": "",
            "isActive": true,
            "mainDepartmentIds": [
                1000
            ],
            "departmentIds": [
                1000
            ],
            "departmentAsteriskIds": [],
            "employeeAsteriskIds": [],
            "birthDate": "",
            "hireDate": "2018-06-27",
            "empNum": "",
            "startWorkDate": "",
            "stopTime": 0,
            "createTime": 1530083843500,
            "updateTime": 1542036068500,
            "nameSpell": "HUANGZHI",
            "nameOrder": "H#BBC6#D6C7"
        }
    ],
    "errorCode": 0,
    "errorMessage": "success",
    "errorDescription": "成功"
}

b) 错误的JSON返回示例:

{
    "errorCode": 20017,
    "errorMessage": "openCorpId not found"
}