Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
服务端API
  • 历史文档（不推荐）
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API（DingTalk OpenAPI）
  • 生态伙伴API
获取凭证（access_token）身份验证（免登）应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理（官方CRM）培训智能硬件
获取凭证（access_token）身份验证（免登）应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理（官方CRM）培训智能硬件
  1. 通讯录信息读取
  • 通用基础
    • 学段
      • 获取学段元数据列表
    • 学科
      • 获取学科元数据列表
      • 创建学科实例
      • 更新学科实例
      • 删除学科实例
      • 获取学科实例详情
      • 获取学科实例列表
    • 查询教育组织类型
      GET
  • 在线课堂
    • 排课
      • 创建课程
      • 修改课程
      • 删除课程
      • 获取课程详情
      • 获取课程列表
      • 添加课程参与方
      • 获取课程参与方列表
      • 移除课程参与方
    • 授课
      • 开始课程
      • 加入课程
      • 结束课程
      • 回放课程
    • 课堂数据
      • 获取课堂概要数据
      • 获取课堂明细数据
  • 家校通讯录2.0
    • 通讯录信息读取
      • 获取部门详情
        POST
      • 获取部门列表
        POST
      • 获取人员列表
        POST
      • 获取人员详情
        POST
      • 获取人员关系列表
        POST
      • 获取人员关系详情
        POST
    • 通讯录信息写入
      • 添加老师
      • 添加家长
      • 学生调班
      • 添加学生
      • 创建学段
      • 初始化家校架构
      • 创建班级
      • 创建年级
      • 删除老师
      • 删除学生
      • 删除家长关系
      • 删除家校部门
      • 创建自定义部门下的班级
      • 创建自定义校区或部门
    • 获取学生信息
      • 获取学生信息
      • 获取学生ID列表
  • 家庭
    • 家庭Feed同步
      POST
    • 查询家庭孩子信息
      POST
    • 学习推荐数据回流
      POST
    • 静态推荐数据同步
      POST
  • 班级圈
    • 获取班级圈话题列表
      POST
    • 获取班级圈动态列表
      POST
  • 数字化证书
    • 获取数字化证书
      POST
  1. 通讯录信息读取

获取人员详情

POST
http://127.0.0.1/topapi/edu/user/get
服务端API/新教育/家校通讯录2.0/通讯录信息读取
最后修改时间：2022-08-30 09:19:24
责任人：未设置

说明#

调用本接口查看班级下的人员详细信息。
服务地址：https://oapi.dingtalk.com

权限#

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

请求参数

Query 参数
access_token
string 
必需
调用服务端接口的授权凭证。企业内部应用可通过调用access_token接口获得。第三方企业应用可通过调用get_corp_token接口获得。
示例值:
6d1bxxxx
Body 参数application/json
class_id
number 
班级ID。
必需
role
string 
必需
家校人员角色：teacher：老师guardian：监护人student：学生
userid
string 
必需
人员userid。企业内部应用可通过根据手机号获取userid接口获取。第三方企业应用可通过获取部门用户接口获取。
示例
{
  "role": "student",
  "class_id": 4240006,
  "userid": "manager9707"
}

示例代码

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/edu/user/get?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "role": "student",
    "class_id": 4240006,
    "userid": "manager9707"
}'

返回响应

🟢200成功
application/json
Body
result
object 
返回结果。
可选
details
array [object {8}] 
人员身份详情。
可选
success
boolean 
是否成功。
可选
errcode
number 
返回码。
可选
errmsg
string 
可选
调用失败时返回的错误描述。
object 
请求ID。
可选
示例
{
  "result": {
    "details": [
      {
        "class_id": 0,
        "role": "string",
        "feature": "string",
        "is_adviser": "string",
        "student_no": "string",
        "name": "string",
        "unionid": "string",
        "userid": "string"
      }
    ]
  },
  "success": true,
  "errcode": 0,
  "errmsg": "string",
  "": {}
}
上一页
获取人员列表
下一页
获取人员关系列表
Built with