Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
服务端API
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
  1. 用户管理
  • 用户管理
    • 创建用户
      POST
    • 更新用户信息
      POST
    • 删除用户
      POST
    • 根据userid获取用户详情
      POST
    • 获取部门用户基础信息
      POST
    • 获取部门用户userid列表
      POST
    • 获取部门用户详情
      POST
    • 获取员工人数
      POST
    • 获取未登录钉钉的员工列表
      POST
    • 根据手机号获取userid
      POST
    • 根据unionid获取用户userid
      POST
    • 获取管理员列表
      POST
    • 获取管理员通讯录权限范围
      POST
    • 获取管理员的应用管理权限
      GET
  • 部门管理
    • 创建部门
      POST
    • 更新部门
      POST
    • 删除部门
      POST
    • 获取部门详情
      POST
    • 获取部门列表
      POST
    • 获取子部门ID列表
      POST
    • 获取指定部门的所有父部门列表
      POST
    • 获取指定用户的所有父部门列表
      POST
  • 角色管理
    • 创建角色
      POST
    • 创建角色组
      POST
    • 更新角色
      POST
    • 批量增加员工角色
      POST
    • 删除角色
      POST
    • 批量删除员工角色
      POST
    • 设定角色成员管理范围
      POST
    • 获取角色组列表
      POST
    • 获取角色列表
      POST
    • 获取角色详情
      POST
    • 获取指定角色的员工列表
      POST
  • 外部联系人
    • 添加外部联系人
    • 删除外部联系人
    • 更新外部联系人
    • 获取外部联系人列表
    • 获取外部联系人标签列表
    • 获取外部联系人详情
  • 行业通讯录
    • 获取部门详情
    • 获取部门下人员列表
    • 获取部门列表
    • 获取部门用户详情
    • 获取企业信息
  • 获取通讯录权限范围
    GET
  1. 用户管理

根据userid获取用户详情

POST
http://127.0.0.1/topapi/v2/user/get
服务端API/通讯录管理/用户管理
最后修改时间:2022-08-30 09:19:22
责任人:未设置

说明#

调用本接口获取指定用户的详细信息。
服务地址:https://oapi.dingtalk.com

权限#

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

请求参数

Query 参数
access_token
string 
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
be3Fxxxx
Body 参数application/json
userid
string 
必需
用户的userid。
language
string 
可选
通讯录语言。zh_CN:中文(默认值)en_US:英文
示例
{
  "language": "zh_CN",
  "userid": "manager4220"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/topapi/v2/user/get?access_token=be3Fxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "language": "zh_CN",
    "userid": "manager4220"
}'

返回响应

🟢200成功
application/json
Body
request_id
string 
请求ID。
可选
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
result
object 
返回结果。
可选
userid
string 
可选
员工的userid。
unionid
string 
可选
员工在当前开发者企业账号范围内的唯一标识。
name
string 
员工名称。
可选
avatar
string 
头像。
可选
state_code
string 
可选
国际电话区号。第三方企业应用不返回该参数。
manager_userid
string 
员工的直属主管。
可选
mobile
string 
可选
手机号码。第三方企业应用不返回该参数。
hide_mobile
boolean 
可选
是否号码隐藏:true:隐藏false:不隐藏隐藏手机号后,手机号在个人资料页隐藏,但仍可对其发DING、发起钉钉免费商务电话。
telephone
string 
可选
分机号。第三方企业应用不返回该参数。
job_number
string 
员工工号。
可选
title
string 
职位。
可选
email
string 
可选
员工邮箱。第三方企业应用不返回该参数。
work_place
string 
可选
办公地点。第三方企业应用不返回该参数。
remark
string 
可选
备注。第三方企业应用不返回该参数。
login_id
string 
专属帐号登录名。
可选
exclusive_account_type
string 
可选
专属帐号类型:sso:企业自建专属帐号dingtalk:钉钉自建专属帐号
exclusive_account
boolean 
是否专属帐号。
可选
dept_id_list
array[number]
所属部门ID列表。
可选
dept_order_list
array [object {2}] 
可选
员工在对应的部门中的排序。
extension
string 
可选
扩展属性,最大长度2000个字符。第三方企业应用不返回该参数。
hired_date
number 
可选
入职时间,Unix时间戳,单位毫秒。第三方企业应用不返回该参数。
active
boolean 
可选
是否激活了钉钉:true:已激活false:未激活
real_authed
boolean 
可选
是否完成了实名认证:true:已认证false:未认证
org_email
string 
可选
员工的企业邮箱。如果员工的企业邮箱没有开通,返回信息中不包含该数据。第三方企业应用不返回该参数。
org_email_type
string 
可选
员工的企业邮箱类型。
senior
boolean 
可选
是否为企业的高管:true:是false:不是
admin
boolean 
可选
是否为企业的管理员:true:是false:不是
boss
boolean 
可选
是否为企业的老板:true:是false:不是
leader_in_dept
array [object {2}] 
可选
员工在对应的部门中是否领导。
role_list
array [object {3}] 
角色列表。
可选
union_emp_ext
object 
可选
当用户来自于关联组织时的关联信息。
示例
{
  "request_id": "string",
  "errcode": 0,
  "errmsg": "string",
  "result": {
    "userid": "string",
    "unionid": "string",
    "name": "string",
    "avatar": "string",
    "state_code": "string",
    "manager_userid": "string",
    "mobile": "string",
    "hide_mobile": true,
    "telephone": "string",
    "job_number": "string",
    "title": "string",
    "email": "string",
    "work_place": "string",
    "remark": "string",
    "login_id": "string",
    "exclusive_account_type": "string",
    "exclusive_account": true,
    "dept_id_list": [
      0
    ],
    "dept_order_list": [
      {
        "dept_id": 0,
        "order": 0
      }
    ],
    "extension": "string",
    "hired_date": 0,
    "active": true,
    "real_authed": true,
    "org_email": "string",
    "org_email_type": "string",
    "senior": true,
    "admin": true,
    "boss": true,
    "leader_in_dept": [
      {
        "dept_id": 0,
        "leader": true
      }
    ],
    "role_list": [
      {
        "id": 0,
        "name": "string",
        "group_name": "string"
      }
    ],
    "union_emp_ext": {
      "userid": "string",
      "union_emp_map_list": [
        {
          "userid": "string",
          "corp_id": "string"
        }
      ],
      "corp_id": "string"
    }
  }
}
上一页
删除用户
下一页
获取部门用户基础信息
Built with