Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
历史文档(不推荐)
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
HTTP回调审批待办通讯录管理钉钉红包身份验证(免登)花名册行业连接日程
HTTP回调审批待办通讯录管理钉钉红包身份验证(免登)花名册行业连接日程
  1. 用户管理1.0(不推荐)
  • 用户管理1.0(不推荐)
    • 创建用户
      POST
    • 更新用户信息
      POST
    • 删除用户
      GET
    • 根据userid获取用户详情
      GET
    • 获取部门用户基础信息
      GET
    • 获取部门用户userid列表
      GET
    • 获取部门用户详情
      GET
    • 获取员工人数
      GET
    • 获取未登录钉钉的员工列表
      POST
    • 根据手机号获取userid
      GET
    • 根据unionid获取userid
      GET
    • 获取管理员列表
      GET
  • 部门管理1.0(不推荐)
    • 创建部门
      POST
    • 删除部门
      GET
    • 更新部门
      POST
    • 获取部门详情
      GET
    • 获取部门列表
      GET
    • 获取子部门ID列表
      GET
    • 获取指定部门的所有父部门列表
      GET
    • 获取指定用户的所有父部门列表
      GET
  1. 用户管理1.0(不推荐)

根据userid获取用户详情

GET
http://127.0.0.1/user/get
历史文档(不推荐)/通讯录管理/用户管理1.0(不推荐)
最后修改时间:2022-08-30 09:19:22
责任人:未设置

说明#

调用本接口根据userid获取用户详情。
服务地址:https://oapi.dingtalk.com

权限#

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考权限申请。
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是开发者后台申请调试
第三方企业应用是开发者后台申请调试
第三方个人应用否——

请求参数

Query 参数
access_token
string 
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
6ed1bxxx
userid
string 
必需
员工唯一标识userid。企业内部应用可通过根据手机号获取userid接口获取。第三方企业企业应用可通过获取部门用户列表接口获取。
示例值:
userid1
lang
string 
可选
通讯录语言,默认zh_CN。
示例值:
zh_CN
Body 参数application/json
object {0}
示例
{}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://127.0.0.1/user/get?access_token=6ed1bxxx&userid=userid1' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功
application/json
Body
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
userid
string 
可选
员工在当前企业内的唯一标识,也称staffId。
unionid
string 
可选
员工在当前开发者企业账号范围内的唯一标识,系统生成,固定值,不会改变。
managerUserid
string 
可选
员工直属主管的userid。
hiredDate
string 
可选
入职时间,Unix时间戳 。在OA后台通讯录中的员工基础信息中维护过入职时间才会返回。第三方企业应用不返回该参数。
tel
string 
可选
分机号。第三方企业应用不返回该参数。
remark
string 
可选
备注。第三方企业应用不返回该参数。
workPlace
string 
可选
办公地点。第三方企业应用不返回该参数。
name
string 
成员名称。
可选
position
string 
职位信息。
可选
mobile
string 
可选
手机号。第三方企业应用不返回该参数。
stateCode
string 
可选
国家地区码。第三方企业应用不返回该参数。
email
string 
可选
员工的邮箱。第三方企业应用不返回该参数。
orgEmail
string 
可选
员工的企业邮箱。如果员工的企业邮箱没有开通,返回信息中不包含该数据。第三方企业应用不返回该参数。
isSenior
boolean 
可选
是否开启高管模式:true:开启开启后,手机号码对所有员工隐藏。普通员工无法对其发DING、发起钉钉免费商务电话。高管之间不受影响。false:不开启
jobnumber
string 
可选
员工工号,对应显示到OA后台和客户端个人资料的工号栏目。长度为0~64个字符。
active
boolean 
可选
是否已经激活:true:表示已激活false:表示未激活
avatar
string 
头像URL。
可选
extattr
string 
可选
扩展属性,可以设置多种属性。第三方企业应用不返回该参数。手机上最多只能显示10个扩展属性,可登录OA管理后台 > 设置 > 通讯录信息进行设置。查看扩展属性:链接类型扩展属性,只支持在“移动端钉钉-点击该用户头像-个人资料页”查看,点击链接可以跳转。链接类型支持变量通配符自动替换,目前支持通配符有:userid,corpid。示例: 工位地址。非链接类型扩展属性,支持在“移动端钉钉/PC端钉钉-点击该用户头像-个人资料页”查看。
roles
array [object {4}] 
用户所在角色列表。
可选
id
number 
角色ID。
可选
name
string 
角色名称。
可选
type
number 
可选
标签组。type返回值如下:type is null:自建0(可以删除):系统生成1:默认员工标签组101:主管理员102:子管理员103:负责人104:部门主管201:项目角色标签组
groupName
string 
角色组名称。
可选
department
string 
可选
数组类型,数组里面值为整型,成员所属部门ID列表。
orderInDepts
string 
可选
在对应的部门中的排序,Map结构的json字符串。Key是部门的ID,Value是人员在这个部门的排序值。
isAdmin
boolean 
可选
是否为企业的管理员:true:是false:不是
isLeaderInDepts
string 
可选
在对应的部门中是否为主管。key是部门的ID,value是人员在这个部门中是否为主管,true表示是,false表示不是。
isHide
boolean 
可选
是否号码隐藏:true:隐藏隐藏手机号后,手机号在个人资料页隐藏,但仍可对其发DING、发起钉钉免费商务电话。false:不隐藏
isBoss
boolean 
可选
是否为企业的老板:true:表示是false:表示不是
realAuthed
boolean 
可选
是否实名认证:true:是false:否
示例
{
  "errcode": 0,
  "errmsg": "string",
  "userid": "string",
  "unionid": "string",
  "managerUserid": "string",
  "hiredDate": "string",
  "tel": "string",
  "remark": "string",
  "workPlace": "string",
  "name": "string",
  "position": "string",
  "mobile": "string",
  "stateCode": "string",
  "email": "string",
  "orgEmail": "string",
  "isSenior": true,
  "jobnumber": "string",
  "active": true,
  "avatar": "string",
  "extattr": "string",
  "roles": [
    {
      "id": 0,
      "name": "string",
      "type": 0,
      "groupName": "string"
    }
  ],
  "department": "string",
  "orderInDepts": "string",
  "isAdmin": true,
  "isLeaderInDepts": "string",
  "isHide": true,
  "isBoss": true,
  "realAuthed": true
}
上一页
删除用户
下一页
获取部门用户基础信息
Built with