飞书 API
  1. 通讯录
飞书 API
  • 应用权限
    • 简介
    • 权限列表
  • API 调用服务指南
    • API 列表
    • 通用参数
    • 频控策略
    • 通用错误码
    • 调用流程
      • 流程概述
      • 申请权限
      • 获取访问凭证
      • 设置 IP 白名单
      • 调用 API
  • 事件订阅指南
    • 概述
    • 事件列表
    • 订阅流程
      • 配置 Encrypt Key
      • 修改 Verification Token
      • 配置请求地址
      • 添加事件
      • 申请权限
      • 接收并处理事件
  • 服务端 SDK
    • 服务端 SDK
  • 鉴权管理
    • 访问凭证
      • 自建应用获取 tenant_access_token
      • 自建应用获取 app_access_token
      • 商店应用获取 app_access_token
      • 商店应用获取 tenant_access_token
      • 获取 user_access_token
      • 刷新 user_access_token
      • 重新获取 app_ticket
    • 登录态管理
      • 资源介绍
      • 获取登录预授权码
      • 获取登录用户信息
      • 批量获取脱敏的用户登录信息
  • 事件管理
    • 获取事件出口 IP
      GET
  • 通讯录
    • 概述
    • 常见问题
    • 权限范围
      • 资源介绍
      • 权限范围详解
      • 事件
        • 通讯录权限范围变更
      • 获取通讯录授权范围
    • 用户
      • 资源介绍
      • 国家/地区 Code 参照表
      • 事件
        • 员工信息被修改
        • 员工离职
        • 员工入职
      • 创建用户
      • 删除用户
      • 修改用户部分信息
      • 获取单个用户信息
      • 更新用户所有信息
      • 获取单个用户信息
      • 获取部门直属用户列表
      • 通过手机号或邮箱获取用户 ID
    • 用户组
      • 资源介绍
      • 创建用户组
      • 删除用户组
      • 更新用户组
      • 查询指定用户组
      • 查询用户组列表
      • 查询用户所属用户组
    • 自定义用户字段
      • 资源介绍
      • 事件
        • 成员字段变更
      • 获取企业自定义用户字段
    • 人员类型
      • 资源介绍
      • 事件
        • 新建人员类型
        • 启用人员类型
        • 停用人员类型
        • 删除人员类型
        • 修改人员类型名称
      • 新增人员类型
      • 删除人员类型
      • 更新人员类型
      • 查询人员类型
    • 部门
      • 资源介绍
      • 事件
        • 创建部门
        • 删除部门
        • 修改部门信息
      • 创建部门
      • 删除部门
      • 修改部门部分信息
      • 获取单个部门信息
      • 更新部门所有信息
      • 部门群转为普通群
      • 获取单个部门信息
      • 获取子部门列表
      • 获取父部门信息
      • 搜索部门
    • 单位
      • 资源介绍
      • 创建单位
      • 删除单位
      • 修改单位信息
      • 建立部门与单位的绑定关系
      • 解除部门与单位的绑定关系
      • 获取单位绑定的部门列表
      • 获取单位信息
      • 获取单位列表
    • 用户组成员
      • 资源介绍
      • 添加用户组成员
      • 批量添加用户组成员
      • 移除用户组成员
      • 查询用户组成员列表
      • 批量移除用户组成员
  • 消息
    • 概述
    • 常见问题
    • 消息内容介绍
      • 发送消息内容
      • 接收消息内容
    • 消息管理
      • 资源介绍
      • 事件
        • 接收消息
        • 消息已读
        • 撤回消息
      • 发送消息
      • 回复消息
      • 撤回消息
      • 查询消息已读信息
      • 获取会话历史消息
      • 获取消息中的资源文件
      • 获取指定消息的内容
    • 消息加急
      • 发送应用内加急
      • 发送短信加急
      • 发送电话加急
    • 批量消息
      • 批量发送消息
      • 批量撤回消息
      • 查询批量消息推送和阅读人数
      • 查询批量消息整体进度
    • 图片信息
      • 上传图片
      • 下载图片
    • 文件信息
      • 上传文件
      • 下载文件
    • 消息-消息卡片
      • 资源介绍
      • 更新应用发送的消息卡片
      • 延时更新消息卡片
      • 发送仅特定人可见的消息卡片
      • 删除仅特定人可见的消息卡片
    • 表情回复
      • 资源介绍
      • 表情文案说明
      • 事件
        • 新增消息表情回复
        • 删除消息表情回复
      • 添加消息表情回复
      • 删除消息表情回复
      • 获取消息表情回复
    • Pin
      • Pin 消息
      • 移除 Pin 消息
      • 获取群内 Pin 消息
  • 群组
    • 概述
    • 群组管理
      • 资源介绍
      • 群 ID 说明
      • 事件
        • 群解散
        • 群配置修改
      • 创建群
      • 解散群
      • 更新群信息
      • 更新群发言权限
      • 获取群信息
      • 更新群置顶
      • 撤销群置顶
      • 获取用户或机器人所在的群列表
      • 搜索对用户或机器人可见的群列表
      • 获取群成员发言权限
      • 获取群分享链接
    • 群成员
      • 资源介绍
      • 事件
        • 用户进群
        • 用户出群
        • 撤销拉用户进群
        • 机器人进群
        • 机器人被移出群
        • 用户和机器人的会话首次被创建
      • 指定群管理员
      • 删除群管理员
      • 将用户或机器人拉入群聊
      • 用户或机器人主动加入群聊
      • 将用户或机器人移出群聊
      • 获取群成员列表
      • 判断用户或机器人是否在群里
    • 群公告
      • 资源介绍
      • 更新群公告信息
      • 获取群公告信息
    • 会话标签页
      • 添加会话标签页
      • 删除会话标签页
      • 更新会话标签页
      • 会话标签页排序
      • 拉取会话标签页
    • 群菜单
      • 资源介绍
      • 添加群菜单
      • 删除群菜单。
      • 修改群菜单元信息
      • 排序群菜单
      • 获取群菜单
  • 云文档
    • 概述
    • 常见问题
    • 云空间
      • 云空间概述
      • 云空间常见问题
      • 文件夹
        • 获取我的空间(root folder)元信息
        • 获取文件夹下的清单
        • 获取文件夹元信息
        • 新建文件夹
        • 移动文件
        • 删除文件
      • 文件
        • 异步任务状态
          • 查询异步任务状态
        • 获取文档元数据
        • 新建在线文档
        • 复制文件
        • 移动文件
        • 删除文件
        • 获取文件统计信息
      • 素材
        • 素材概述
        • 分片上传素材
          • 概述
          • 分片上传素材(预上传)
          • 分片上传素材(上传分片)
          • 分片上传素材(完成上传)
        • 上传素材
        • 下载素材
        • 获取素材临时下载链接
      • 事件
        • 列表
          • 多维表格字段变更
          • 多维表格记录变更
          • 文件标题变更
          • 文件已读
          • 文件编辑
          • 文件协作者添加
          • 文件协作者移除
          • 文件删除到回收站
          • 文件彻底删除
        • 订阅云文档事件
      • 搜索
        • 文档搜素
      • 上传
        • 分片上传文件
          • 概述
          • 分片上传文件(预上传)
          • 分片上传文件(上传分片)
          • 分片上传文件(完成上传)
        • 上传文件
      • 下载
        • 下载文件
      • 导入
        • 概述
        • 创建导入任务
        • 查询导入结果
      • 导出
        • 导出文件指南
        • 创建导出任务
        • 查询导出任务结果
        • 下载导出文件
      • 文档版本
        • 概述
        • 创建文档版本
        • 删除文档版本
        • 获取文档版本
        • 获取文档版本列表
    • 权限
      • 权限概述
      • 常见问题
      • 成员
        • 转移所有者
        • 判断当前用户是否有某权限
        • 获取协作者列表(新版本)
        • 获取协作者列表
        • 增加协作者权限
        • 更新协作者权限
        • 移除协作者权限
      • 设置
        • 获取云文档权限设置
        • 更新云文档权限设置
    • 评论
      • 分页获取文档评论
      • 添加评论
      • 获取评论
      • 更新回复
      • 删除回复
      • 解决/恢复 评论
    • 文档
      • 新版文档接入指南
      • 新版文档
        • 概述
        • 数据结构
        • 接入指南
        • 文档
          • 获取文档基本信息
          • 获取文档纯文本内容
          • 获取文档所有块
          • 创建文档
        • 块
          • 获取块
          • 创建块
          • 更新块
          • 批量更新块
          • 删除块
          • 获取所有子块
      • 旧版文档
        • 概述
        • 准备接入文档 API
        • 文档数据结构概述
        • 文档数据结构参考
        • 文档
          • 创建文档
        • 内容
          • 获取文档富文本内容
          • 获取文档文本内容
          • 编辑文档内容
    • 权限
      • 权限成员
        • 增加权限
        • 判断协作者是否有某权限
      • 权限设置
        • 获取文档公共设置V2
        • 更新文档公共设置
      • 转移拥有者
    • 电子表格
      • 概述
      • 电子表格常见问题
      • 支持写入的数据类型
      • 支持数字格式类型
      • 表格
        • 修改电子表格属性
        • 获取电子表格信息
        • 创建表格
      • 工作表
        • 查询工作表
        • 获取工作表
        • 操作工作表
        • 更新工作表属性
      • 行列
        • 增加行列
        • 插入行列
        • 更新行列
        • 移动行列
        • 删除行列
      • 单元格
        • 追加数据
        • 插入数据
        • 读取单个范围
        • 读取多个范围
        • 向单个范围写入数据
        • 向多个范围写入数据
        • 设置单元格样式
        • 批量设置单元格样式
        • 写入图片
        • 合并单元格
        • 拆分单元格
        • 查找单元格
        • 替换单元格
      • 筛选
        • 筛选指南
        • 获取筛选
        • 创建筛选
        • 更新筛选
        • 删除筛选
      • 筛选视图
        • 筛选条件
          • 筛选视图的筛选条件指南
          • 创建筛选条件
          • 查询筛选条件
          • 更新筛选条件
          • 删除筛选条件
          • 获取筛选条件
        • 更新筛选视图
        • 获取筛选视图
        • 查询筛选视图
        • 创建筛选视图
        • 删除筛选视图
      • 表格操作
        • 创建表格
        • 获取表格元数据
        • 更新表格属性
        • 操作工作表
        • 更新工作表属性
      • 保护范围
        • 增加保护范围
        • 获取保护范围
        • 修改保护范围
        • 删除保护范围
      • 数据校验
        • 概述
        • 设置下拉列表
        • 删除下拉列表设置
        • 更新下拉列表设置
        • 查询下拉列表设置
      • 条件格式
        • 条件格式指南
        • 创建条件格式
        • 获取条件格式
        • 更新条件格式
        • 删除条件格式
      • 浮动图片
        • 浮动图片指南
        • 创建浮动图片
        • 获取浮动图片
        • 查询浮动图片
        • 更新浮动图片
        • 删除浮动图片
    • API参考
      • 创建文档
      • 编辑文档内容
      • 历史文档(不建议)
        • 获取文档中的电子表格的元数据
      • 获取文档元信息
    • 多维表格
      • 概述
      • 接入指南
      • 数据结构
      • 多维表格
        • 获取多维表格元数据
        • 更新多维表格元数据
      • 数据表
        • 更新数据表
        • 列出数据表
        • 新增数据表
        • 新增多个数据表
        • 删除一个数据表
        • 删除多个数据表
      • 仪表盘
        • 复制仪表盘
        • 列出仪表盘
      • 视图
        • 更新视图
        • 检索视图
        • 列出视图
        • 新增视图
        • 删除视图
      • 表单
        • 更新表单元数据
        • 获取表单元数据
        • 更新表单问题
        • 列出表单问题
      • 记录
        • 记录筛选开发指南
        • 检索记录
        • 列出记录
        • 新增记录
        • 更新记录
        • 删除记录
        • 新增多条记录
        • 更新多条记录
        • 删除多条记录
      • 字段
        • 字段编辑指南
        • 附件字段说明
        • 列出字段
        • 新增字段
        • 更新字段
        • 删除字段
      • 高级权限
        • 概述
        • 自定义角色
          • 列出自定义角色
          • 新增自定义角色
          • 删除自定义角色
          • 更新自定义角色
        • 协作者
          • 批量删除协作者
          • 批量新增协作者
          • 列出协作者
          • 新增协作者
          • 删除协作者
    • 知识库
      • 概述
      • 常见问题
      • 知识空间
        • 创建知识空间
        • 获取知识空间列表
        • 获取知识空间信息
      • 空间成员
        • 删除知识空间成员
        • 添加知识空间成员
      • 空间设置
        • 更新知识空间设置
      • 节点
        • 创建知识空间节点
        • 获取知识空间节点信息
        • 获取知识空间子节点列表
        • 移动知识空间节点
        • 更新知识空间节点标题
        • 创建知识空间节点副本
      • 任务
        • 获取任务结果
      • 云文档
        • 移动云空间文档至知识空间
        • 获取任务结果
      • 搜索 Wiki
        • 搜索 Wiki
    • 云文档助手
      • 订阅
        • 获取订阅状态
        • 创建订阅
        • 更新订阅状态
  • 日历
    • 概述
    • 常见问题
    • 日历管理
      • 资源介绍
      • 事件
        • 日历变更
      • 获取主日历
      • 创建共享日历
      • 删除共享日历
      • 查询主日历信息
      • 查询主日历忙闲信息
      • 查询日历信息
      • 查询日历列表
      • 更新日历
      • 搜索日历
      • 订阅日历
      • 取消订阅日历
      • 订阅日历变更事件
      • 取消订阅日历变更事件
    • 日历访问控制
      • 资源介绍
      • 事件
        • 创建 ACL
        • 删除 ACL
      • 取消订阅日历访问控制变更事件
      • 创建访问控制
      • 删除访问控制
      • 获取访问控制列表
      • 订阅日历访问控制变更事件
    • 日程管理
      • 资源介绍
      • 事件
        • 日程变更
      • 创建日程
      • 删除日程
      • 更新日程
      • 获取日程
      • 获取日程列表
      • 搜索日程
      • 订阅日程变更事件
      • 取消订阅日程变更事件
    • 请假日程管理
      • 资源介绍
      • 创建请假日程
      • 删除请假日程
    • 会议室日程管理
      • 事件
        • 会议室状态信息变更
        • 第三方会议室日程变动
      • 查询会议室日程主题和会议详情
      • 查询会议室忙闲
      • 回复会议室日程实例
    • 日程参与人
      • 资源介绍
      • 获取日程参与群成员列表
      • 添加日程参与人
      • 获取日程参与人列表
      • 删除日程参与人
    • 同步到本地日历
      • 生成 CalDAV 配置
    • 同步 Exchange 日历信息
      • 资源介绍
      • 将 Exchange 账户绑定到飞书账户
      • 解除 Exchange 账户绑定
      • 查询 Exchange 账户的绑定状态
  • 视频会议
    • 视频会议概述
    • 预约
      • 资源介绍
      • 预约会议
      • 删除预约
      • 更新预约
      • 获取预约
      • 获取活跃会议
    • 会议
      • 资源介绍
      • 事件
        • 企业会议开始
        • 企业会议结束
        • 会议开始
        • 会议结束
        • 加入会议
        • 离开会议
        • 开始录制
        • 停止录制
        • 录制完成
        • 屏幕共享开始
        • 屏幕共享结束
      • 邀请参会人
      • 移除参会人
      • 设置主持人
      • 结束会议
      • 获取会议详情
      • 获取与会议号相关联的会议列表
    • 录制
      • 资源介绍
      • 开始录制
      • 停止录制
      • 获取录制文件
      • 授权录制文件
    • 会议报告
      • 资源介绍
      • 获取会议报告
      • 获取top用户列表
    • 导出
      • 资源介绍
      • 导出会议明细
      • 导出参会人明细
      • 导出参会人会议质量数据
      • 导出会议室预定数据
      • 查询导出任务结果
      • 下载导出文件
    • 会议室层级
      • 资源介绍
      • 创建会议室层级
      • 删除会议室层级
      • 更新会议室层级
      • 查询会议室层级详情
      • 批量查询会议室层级详情
      • 查询会议室层级列表
      • 搜索会议室层级
    • 会议室管理
      • 资源介绍
      • 事件
        • 创建会议室
        • 更新会议室
        • 删除会议室
      • 创建会议室
      • 删除会议室
      • 更新会议室
      • 查询会议室详情
      • 批量查询会议室详情
      • 查询会议室列表
      • 搜索会议室
    • 会议室配置
      • 资源介绍
      • 查询会议室配置
      • 设置会议室配置
      • 获取会议室预定范围
      • 更新会议室预定范围
  • 考勤打卡
    • 概述
    • 接入指南
    • 考勤班次
      • 按名称查询班次
      • 删除班次
      • 创建班次
      • 按 ID 查询班次
      • 查询所有班次
    • 考勤组管理
      • 创建或修改考勤组
      • 删除考勤组
      • 按 ID 查询考勤组
      • 按名称查询考勤组
      • 查询所有考勤组
    • 考勤排班
      • 查询班表信息
      • 创建或修改班表
    • 考勤统计
      • 功能介绍
      • 查询统计表头
      • 更新统计设置
      • 查询统计数据
      • 查询统计设置
    • 假勤审批
      • 获取用户审批通过数据
      • 通知审批状态更新
      • 写入审批结果
    • 考勤补卡
      • 获取可补卡时间
      • 获取补卡记录
      • 通知补卡审批发起
    • 打卡信息管理
      • 批量查询打卡流水
      • 查询打卡流水
      • 获取打卡结果
      • 导入打卡流水
    • 考勤用户管理
      • 事件
        • 用户打卡成功
        • 用户任务状态变更
      • 修改用户人脸识别信息
      • 批量查询用户人脸识别信息
      • 上传用户人脸识别照片
      • 下载用户人脸识别照片
  • 审批
    • 概述
    • 常见问题
    • 接入指南
      • 审批接入指南
      • 原生审批接入指南
      • 商店应用开发指南
      • 三方审批接入
        • 三方审批接入指南
        • 三方审批接入准备
        • 审批官方连接器
    • 原生审批定义
      • 资源介绍
      • 关联外部选项说明
      • 创建审批定义
      • 查看指定审批定义
      • 查询审批定义列表
    • 原生审批实例
      • 资源介绍
      • 创建审批实例
      • 撤回审批实例
      • 抄送审批实例
      • 预览审批流程
      • 批量获取审批实例ID
      • 获取单个审批实例详情
    • 原生审批任务
      • 资源介绍
      • 同意审批任务
      • 拒绝审批任务
      • 转交审批任务
      • 退回审批任务
      • 审批任务加签
      • 重新提交审批任务
    • 原生审批文件
      • 资源介绍
      • 上传文件
    • 原生审批评论
      • 资源介绍
      • 创建评论
      • 删除评论
      • 清空评论
      • 获取评论
    • 三方审批定义
      • 资源介绍
      • 三方快捷审批回调
      • 创建三方审批定义
    • 三方审批实例
      • 资源介绍
      • 同步三方审批实例
      • 校验三方审批实例
    • 三方审批任务
      • 资源介绍
      • 获取三方审批任务状态
    • 审批 Bot 消息
      • 发送审批 Bot 消息
      • 更新审批 Bot 消息
    • 审批查询
      • 查询实例列表
      • 查询抄送列表
      • 查询任务列表
      • 查询用户的任务列表
      • 查询审批 ID(专用)
    • 审批事件
      • 功能介绍
      • 订阅步骤
      • 常见问题
      • 事件接口
        • 订阅审批事件
        • 取消订阅审批事件
      • 公用事件
        • 审批抄送状态变更
        • 审批任务状态变更
        • 审批实例状态变更
        • 审批定义更新
      • 特殊事件
        • 出差审批
        • 外出审批
        • 补卡审批
        • 换班审批
        • 加班审批
        • 请假审批
  • 服务台
    • 概述
    • 接入指南
    • 客服
      • 客服功能管理
        • 更新客服信息
        • 获取客服邮箱
      • 客服工作日程
        • 创建客服工作日程
        • 删除客服工作日程
        • 更新客服工作日程
        • 查询指定客服工作日程
        • 查询全部客服工作日程
      • 客服技能
        • 创建客服技能
        • 删除客服技能
        • 更新客服技能
        • 查询指定客服技能
        • 查询全部客服技能
      • 客服技能规则
        • 客服技能及运算符
        • 获取客服技能列表
    • 工单
      • 事件
        • 创建工单
        • 工单状态变更
      • 工单管理
        • 创建服务台对话
        • 更新工单详情
        • 查询指定工单详情
        • 获取服务台工单内消息图像
        • 回复用户提问结果至工单
        • 查询全部工单详情
        • 获取服务台自定义字段
      • 工单消息
        • 工单消息内容
        • 发送工单消息
        • 获取工单消息详情
        • 服务台机器人向工单绑定的群内发送消息
      • 工单自定义字段
        • 概述
        • 创建工单自定义字段
        • 删除工单自定义字段
        • 更新工单自定义字段
        • 获取指定工单自定义字段
        • 获取全部工单自定义字段
      • 工单自定义字段
    • 知识库
      • 知识库管理
        • 富文本
        • 创建知识库
        • 获取知识库详情
        • 修改知识库
        • 删除知识库
        • 获取全部知识库详情
        • 获取知识库图像
        • 搜索知识库
      • 知识库分类
        • 创建知识库分类
        • 获取知识库分类
        • 更新知识库分类详情
        • 删除知识库分类详情
        • 获取全部知识库分类
    • 推送中心
      • 事件
        • 推送审核通知事件
      • 创建推送
      • 更新推送
      • 查询推送
      • 预览推送
      • 提交审核
      • 取消审核
      • 执行推送
      • 取消推送
    • 事件订阅
      • 订阅服务台事件
      • 取消订阅服务台事件
  • 任务
    • 任务概述
    • Markdown 模块
    • 任务字段补充说明
    • 任务管理
      • 功能介绍
      • 事件
        • 任务信息变更(租户维度)
        • 任务信息变更
      • 创建任务
      • 删除任务
      • 更新任务
      • 完成任务
      • 取消完成任务
      • 查询指定任务
      • 查询所有任务
    • 提醒
      • 功能介绍
      • 新增提醒时间
      • 删除提醒时间
      • 查询提醒时间列表
    • 评论
      • 概述
      • 事件
        • 任务评论信息变更
      • 获取评论列表
      • 创建评论
      • 删除评论
      • 更新评论
      • 获取评论详情
    • 关注人
      • 功能介绍
      • 批量删除关注人
      • 新增关注者
      • 删除指定关注人
      • 获取关注者列表
    • 执行者
      • 功能介绍
      • 批量删除执行者
      • 新增执行者
      • 删除指定执行者
      • 获取执行者列表
  • 邮箱
    • 邮件组
      • 邮件组管理
        • 创建邮件组
        • 删除邮件组
        • 修改邮件组部分信息
        • 修改邮件组全部信息
        • 查询指定邮件组
        • 批量获取邮件组
      • 邮件组成员
        • 创建邮件组成员
        • 删除邮件组成员
        • 查询指定邮件组成员
        • 获取所有邮件组成员
        • 批量创建邮件组成员
        • 批量删除邮件组成员
      • 邮件组别名
        • 创建邮件组别名
        • 删除邮件组别名
        • 获取邮件组所有别名
      • 邮件组权限成员
        • 创建邮件组权限成员
        • 删除邮件组权限成员
        • 获取邮件组权限成员
        • 批量获取邮件组权限成员
        • 批量创建邮件组权限成员
        • 批量删除邮件组权限成员
    • 公共邮箱
      • 公共邮箱管理
        • 创建公共邮箱
        • 删除公共邮箱
        • 修改公共邮箱
        • 修改公共邮箱全部信息
        • 查询所有公共邮箱
        • 查询指定公共邮箱
      • 公共邮箱成员
        • 添加公共邮箱成员
        • 删除公共邮箱成员
        • 删除公共邮箱所有成员
        • 获取公共邮箱成员信息
        • 查询所有公共邮箱成员信息
        • 批量添加公共邮箱成员
        • 批量删除公共邮箱成员
      • 公共邮箱别名
        • 创建公共邮箱别名
        • 删除公共邮箱别名
        • 查询公共邮箱的所有别名
    • 用户邮箱
      • 从回收站删除用户邮箱地址
      • 创建用户邮箱别名
      • 删除用户邮箱别名
      • 获取用户邮箱所有别名
    • 邮箱地址
      • 查询邮箱地址状态
  • 应用信息
    • 应用管理
      • 校验应用管理员
      • 获取应用管理员管理范围
      • 获取应用在企业内的可用范围
      • 获取用户可用的应用
      • 获取企业安装的应用
      • 更新应用可用范围
      • 查询应用管理员列表
    • 应用商店
      • 查询用户是否在应用开通范围
      • 查询租户购买的付费方案
      • 查询订单详情
    • 应用
      • 获取应用版本列表
      • 查看待审核的应用列表
      • 获取应用信息
      • 获取应用版本信息
      • 更新应用审核状态
      • 更新应用分组信息
    • 应用使用情况
      • 获取应用使用概览
    • 应用反馈
      • 更新应用反馈
      • 获取应用反馈列表
    • 事件
      • 新增应用反馈
      • 反馈更新
      • 应用创建
      • 首次启用应用
      • 应用停启用
      • 应用商店应用购买
      • app_ticket 事件
      • 应用卸载
      • 应用可用性范围增加
      • 申请发布应用
      • 撤回应用发布申请
      • 未命名文档
  • 企业信息
    • 获取企业信息
  • 认证信息
    • 获取认证信息
  • 个人设置
    • 系统统计
      • 功能介绍
      • 创建系统状态
      • 删除系统状态
      • 修改系统状态
      • 获取系统状态
      • 批量开启系统状态
      • 批量关闭系统状态
  • 搜索
    • 概述
    • 接入指南
    • 常见问题
    • 数据源
      • 创建数据源
      • 删除数据源
      • 修改数据源
      • 获取数据源
      • 批量获取所有的数据源
    • 数据项
      • 批量为数据项创建索引
      • 为指定数据项创建索引
      • 获取数据项
      • 删除数据项
    • 数据范式
      • 创建数据范式
      • 删除数据范式
      • 修改数据范式
      • 获取数据范式
  • AI 能力
    • 光学字符识别
      • 识别图片中的文字
    • 语音识别
      • 识别语音文件 (ASR)
      • 识别流式语音 (ASR)
    • 机器翻译
      • 识别文本语种
      • 翻译文本
  • 管理后台
    • 登录密码管理
      • 重置用户的企业邮箱密码
    • 数据报表管理
      • 功能介绍
      • 获取部门维度的用户活跃和功能使用数据
      • 获取用户维度的用户活跃和功能使用数据
    • 企业勋章
      • 功能介绍
      • 勋章管理
        • 创建勋章
        • 修改勋章信息
        • 上传勋章图片
        • 获取勋章列表
        • 获取勋章详情
      • 勋章授予名单
        • 创建授予名单
        • 删除授予名单
        • 修改授予名单
        • 获取授予名单列表
        • 获取授予名单详情
  • 飞书人事(标准版)
    • 接入指南
    • 批量获取员工花名册信息
    • 下载人员的附件
  • 飞书人事(企业版)
    • 休假管理
      • 批量查询员工请假记录
  • 招聘
    • 概述
    • 错误码
    • 招聘相关配置
      • 职位
        • 新建职位
        • 更新职位
        • 更新职位设置
        • 获取职位设置
        • 获取职位信息
        • 获取职位上的招聘人员信息
      • 流程
        • 获取招聘流程信息
    • 获取候选人
      • 内推
        • 获取内推信息
    • 候选人管理
      • 人才
        • 通过手机号或邮箱获取人才 ID
        • 获取人才信息
      • 投递流程
        • 投递管理
          • 创建投递
          • 终止投递
          • 获取投递信息
          • 获取投递列表
        • Offer
          • 获取 Offer 信息
        • 入职
          • 更新 e-HR 导入任务结果
          • 操作候选人入职
          • 更新入职状态
          • 通过投递 ID 获取入职信息
          • 通过员工 ID 获取入职信息
      • 备注
        • 创建备注
        • 更新备注
        • 获取备注
        • 获取备注列表
      • 简历来源
        • 获取简历来源列表
    • 附件
      • 获取附件信息
      • 获取附件预览信息
  • OKR
    • 概述
    • OKR周期
      • 获取OKR周期列表
    • OKR 内容
      • 获取用户的 OKR 列表
      • 批量获取OKR
    • 用户OKR
      • 获取用户的OKR列表
    • OKR 进展记录
      • 创建 OKR 进展记录
      • 删除 OKR 进展记录
      • 更新 OKR 进展记录
      • 获取 OKR 进展记录
      • 上传进展记录图片
    • 指标管理
      • 获取指标库
      • 获取指标表
      • 更新指标项
      • 批量更新指标项
      • 获取指标项
  • 实名认证
    • 录入身份信息
    • 上传人脸基准图片
    • 裁剪人脸图片
    • 查询人脸认证结果
  • 智能门禁
    • 概述
    • 用户管理
      • 事件
        • 用户变更
      • 获取单个用户信息
      • 获取用户列表
      • 修改用户部分信息
      • 上传人脸图片
      • 下载人脸图片
    • 门禁设备
      • 获取设备列表
    • 人脸图片
      • 概述
  • 企业百科
    • 概述
    • 草稿
      • 创建草稿
      • 更新草稿
    • 词条
      • 创建免审词条
      • 更新免审词条
      • 提取潜在的百科词条
      • 获取词条详情
      • 获取词条列表
      • 精准搜索词条
      • 模糊搜索词条
      • 词条高亮
    • 分类
      • 获取百科分类
    • 图片管理
      • 上传图片
      • 下载图片
  • 妙记
    • 获取妙计统计数据
      • 获取妙记统计数据
    • 妙记信息
      • 获取妙记信息
  • 工作台
    • 我的常用推荐规则
      • 获取当前设置的推荐规则列表
  • 企业
    • 获取企业信息
  1. 通讯录

常见问题

通讯录权限范围相关问题#

调用通讯录接口需要哪些权限?#

通讯录模块目前包含成员、部门、用户组等几大模块,每个模块都会提供对应的 API 接口,便于开发者进行智能化的系统对接。开发者对于接口的使用权限主要分为三类:
1.
接口权限要求。定义应用有无权限调用该接口,如果没有权限的调用权限,则无法访问接口。
2.
通讯录权限范围。定义应用查询或操作哪些部门和用户的数据。详见权限范围 。获取或操作某数据时,如果没有该数据的通讯录权限,则会提示无权限。
3.
数据权限要求。由于某些实体(如用户)不同字段的敏感度不同,如用户的手机号,相对比较敏感,要获取就需要额外的权限。如果没有指定字段的获取权限,则无法获取该字段信息。
下面举一个是例子:开发者希望通过 创建用户 接口,向企业中添加用户。
首先,开发者需要确认是否有接口的访问权限,此处为“更新通讯录”的权限。
其次,由于需要将用户添加到某个(或某几个)部门下,因此需要确认是否有待加入部门的通讯录权限。如果没有待加入部门的通讯录权限,是无法操作添加的。
第三,创建完返回或通过 ID 获取用户信息的时候,用户的敏感字段,开发者想要获取,需确认有无敏感字段的权限。

为什么获取不到 user_id/邮箱/手机号等信息?#

满足接口权限要求,也在通讯录权限范围内,依然无法获取到用户的 user_id、邮箱和手机号等信息。通常,这是因为 user_id、邮箱和手机号等信息比较敏感,需要单独申请相对的数据权限。这点在上一个问题中也阐明了,如果要获取和用户相关的敏感信息,需要申请对应的数据权限。详情也可以参考应用权限简介。

user_accss_token 与 tenant_access_token 的权限差异是什么?#

二者使用获取或操作数据时权限过滤范围不一样。
1.
tenant_access_token 基于应用的通讯录范围进行权限的过滤,如调用接口获取部门 A 时,会检查部门 A 是否在应用的通讯录权限范围内。其规则配置入口是Admin管理后台 > 工作台管理 > 应用管理。
2.
user_accss_token 基于用户的可见组织架构范围来做权限过滤。用户可见的组织架构范围为 APP 端上 通讯录 > 组织架构 部分可见的信息。其规则配置入口在 Admin管理后台,进入安全 > 用户权限 > 组织架构可见范围 页面配置。

如何获取企业全部员工信息?#

飞书目前没有单独的接口可以获得全部员工信息,如果需要获取,可以按照以下的步骤操作:
1.
确认开启了全员的通讯录权限范围。如果没有开启全员通讯录权限范围,则无法获取到全员信息。
2.
通过获取部门信息列表接口,设置参数 parent_department_id=0、fetch_child=true,获取企业下所有部门 ID 列表。
3.
在步骤 2 获取部门 ID 列表的基础上,通过获取用户列表接口搭配使用,来获得全部员工的相关信息。

如何获取根部门下的员工信息?#

首先,请确保应用的通讯录权限范围设置为全员或包含根部门下的所有员工。然后,调用获取用户列表接口,设置参数department_id=0,获得根部门下的员工信息。

用户 ID 相关问题#

同一个用户在多个应用的 open_id 是一样的吗?#

不一样。open_id 是用户在应用内唯一标识,因此同一个用户在不同应用中的 open_id 不一样。

同一用户在不同企业的 open_id 和 union_id 是一样的吗?#

不一样。不同的企业内的用户应算作两个用户,因此进行区分。

user_id 能不能更新?#

不能。你可以在创建用户时,将该用户在企业内部系统已存在的唯一 ID 指定为 user_id,若不指定将由系统自动为用户生成一个唯一的随机 ID 作为 user_id。已创建用户的 user_id(部分场景也叫 employee_id)不支持更新,因为各应用方都可能用到并保存 user_id, 如果修改 user_id,可能造成应用感知不到,从而造成应用无法使用等问题。

如何获取 user_id?#

有如下 2 种方式可以获取 user_id:
可以通过邮箱或手机号获取。换取方式见接口使用手机号或邮箱获取用户 ID。
登录管理后台,点击用户详情,查看获取用户 ID。

用户/人员相关问题#

误删了部门或者人员后能按照原有的 ID 恢复吗?#

不能。目前不能恢复原有的 department_id 或者 user_id。企业的 department_id 或者 user_id 是唯一的,建议新增一个 department_id 或者 user_id。

人员的 status 字段什么含义?#

可以将该字段对应的数字转化为二进制,对应位数就是对应的值的状态。
bit0(最低位):1 表示冻结,0 表示未冻结;
bit1:1 表示离职,0 表示在职;
bit2:1 表示未激活,0 表示已激活。
例如,数字 2 转化为二进制就是 010,意味着“已激活、离职、未冻结”;而数字 0 转化为二进制就是 000,意味着“已激活、在职、未冻结”。

如何判断某个应用的用户是否也在使用“我”开发的其他应用?#

某发者开发了多个应用,如果判断其中某个应用的用户是否也在使用该开发者开发的其他应用。
目前可以使用字段 union_id,一个用户在同一个开发者所属的多个应用中,union_id 唯一。

搜索用户接口为什么获取不到返回值?#

如果调用搜索用户接口获取不到返回值,你可以通过以下方式排查原因:
确认你能在飞书客户端的搜索栏中搜到对应用户,且该用户不是外部用户或离职人员。
确认请求参数 page_token 的值是否正确。

为什么不能通过手机号/邮箱获取其他人员信息?#

请确认相关应用的通讯录权限范围包含包含要获取的用户,而不是只有你自己,如果通讯录范围不包含获取的用户,会返回邮箱或手机号不存在。

人员什么时候会被自动拉入部门群?#

可以通过如下步骤排查:
确认部门成员是否进行了调整。
确认该人员是不是被拉入的部门的负责人。

被删除的用户的 user_id 会被后续新增的用户占用吗?#

系统默认生成的 user_id,业务方保存 user_id,删除 A 员工之后,这个 user_id 会不会被后面新增的员工占用吗?
user_id 可能会被新增的员工占用。系统默认生成的 user_id,保证了企业内有效(无效表示已离职用户)用户唯一,开发者或管理员对用户进行删除,再添加,可能会存在新添加的用户的 user_id 和历史上已经删除的用户一样。所以建议增加用户的时候,用具有唯一性标示的 id 作为 user_id,避免造成困扰。
说明: 部门的自定义 ID 也是这个逻辑。

用户接口相关问题#

如何理解用户属性中的自定义字段?#

创建用户接口 和 获取单个用户信息 接口请求或应答的结构体内有自定义字段,应该如何理解该字段?
用户的 custom_attrs 属性是对用户属性的扩展,用于企业根据自身需求灵活扩展用户描述能力,根据取值语法的不同主要分为文本类型、网页类型、枚举类型、图片类型、用户类型。
注意:
请确保你的组织管理员已在 管理后台 > 组织架构 > 成员字段管理 > 自定义字段管理 > 全局设置 中开启了 允许开放平台 API 调用,否则该字段不会生效/返回。
如果需要创建或更新自定义字段的值,请确保自定义字段的 key 已经被企业管理员创建且有效。
各类型的详细介绍如下表所示。
类型描述
文本类型用户的 name 属性,只有一个 string 类型的 value。值对应 text 字段
网页类型字段引用链接,可在成员名片页实现点击跳转效果。该类型字段需要有标题文字,值对应 text 字段,需要有跳转的 URL,值对应 url。由于PC 端的跳转链接可能会和移动端不太一样,所以单独设置了 pc_url 作为跳转的 URL,如果该值不填,则 PC 端链接使用 url
枚举类型实现字段取值在给定选项中选择,如员工类型,包含正式、外包、顾问。企业成员的员工类型,只能在这些选项中选择,该类型的值对应 option_id,也就是管理员配置的某个选项 key
图片类型与枚举类型相似,只是选项的数据类型只能是图片,用于在成员名片页展示其对应的图片,该类型的值对应 option_id,可从管理后台查询对应的图片 id
用户类型该类型主要用于成员名片页展示对另一用户的引用,实现成员名片页之间的跳转,如将“张三”的 HRBP 字段显示“李四”并支持点击跳转至李四的名片页。对应generic_user 下 id为需要引用的成员 user_id,generic_user 下的 type 目前固定为1,表示用户类型

如何使用创建用户接口中的 enterprise_email 字段?#

创建用户接口中的 enterprise_email 字段表示设置用户的企业邮箱。
企业邮箱的域名需要企业在管理后台申请并开启。如果企业没有开启对应域名的企业邮箱,设置用户的企业邮箱会操作失败,请联系企业的管理员确认企业是否在后台启用了该域名的企业邮箱。

如何理解获取用户列表接口?#

获取用户列表接口的设计含义是获取某个部门下的直属用户列表。
数据的获取受到通讯录权限范围的限制:
如果请求带上了部门 ID,首先会检查应用是有该部门的通讯录权限。如果有,就会返回该部门下的直属成员信息。根部门的部门 ID 为 0,如果带上了department_id=0 表检查有没有根部门的通讯录权限,有的话,返回根部门下直属成员信息)。
如果请求没有带上部门 ID,无法进行 ID 的通讯录权限校验,就会获取到权限范围内的独立成员。当权限范围包含了某成员,但不包含成员所在部门,则该成员视为权限范围内的独立成员。
所以开发者在使用该接口时,应该结合通讯录的权限以及要获取的数据,来决定要不要带部门 ID。

部门接口相关问题#

如何获取父部门下所有员工的通讯录信息?#

目前不能通过一个接口来获取父部门下所有员工的通讯录信息,可以通过接口组合实现:
首先,通过获取部门信息列表接口获取父部门下所有部门的 department_id。
然后,通过获取用户列表接口获取每个部门下员工的通讯录信息。

为什么获取到的 department_id 有的带 od-,有的不带?#

通过获取单个部门信息接口获取到 department_id,有时带有 "od-" 前缀,有时没有。
请确认请求是否指定了不同的 department_id_type,若没指定,默认是 open_department_id,会带有 “od-”前缀。有关 department_id 的详细介绍,请参考通用参数。

如何理解获取部门信息列表接口?#

获取部门信息列表 接口的功能是获取部门下的子部门信息。数据的获取受到通讯录权限范围的限制:
如果请求带上了父部门 ID,首先会检查应用是否有该部门的通讯录权限,如果有,则返回该部门下的子部门信息。并且,根据 fetch_child 的取值来决定是否递归查询子部门信息。根部门的部门 ID 为 0,如果带上了 0,会校验是否有全员权限。
如果请求没有带上父部门 ID,无法进行部门通讯录权限校验,就会根据通讯录权限范围返回数据:如果通讯录范围是全员,就会返回单个根部门 ID,根部门 ID 为 0,开发者可以通过根部门 ID 继续请求;否则返回通讯录范围的部门信息。
所以开发者在使用该接口时,应该结合通讯录的权限以及要获取的数据,来决定如何使用,要不要带父部门 ID。

错误排查#

没有完全获取批量信息,但是提示执行成功#

使用批量获取信息接口的时候,只返回了部分信息,没有返回全部批量信息。接口仍会提示任务执行成功, msg 也会返回 success。这是因为:
批量接口的返回值是指当前批量任务的执行情况,意味是否执行,而非是否执行成功。只要能开始执行都会记为“执行”。详细的执行情况可以通过查询批量任务执行状态接口获取。

新增用户接口返回 email and mobile account conflict#

新增用户接口返回 email and mobile account conflict,这个问题的原因是:
新增用户时,同时设置手机号与邮箱,会将两者同时作为登录凭证关联到同一个账号上。
如果使用手机号和邮箱分别注册了两个不同的账号,则手机号和邮箱分别对应登录凭证不同的两个账号。此时,新增用户,同时设置手机号与邮箱,则无法判断应当关联到哪一个账号上,从而报上述错误。
解决方案:注销其中一个账号,再新增用户。

新增用户接口返回 department id xxxxxxxx is not exist#

如果新增用户返回 department id xxxxxxxx is not exist,请参考如下方法解决这个问题:
确认写入的 department id 是否存在。
确认是否误用了 open_department_id。open_department_id 和 department_id 是两个不同的 ID。
确认应用是否在该部门的通讯录权限范围内。

【飞书】API开发者 微信交流群

用微信扫右侧二维码,加入【飞书】API开发者 交流群,互助沟通

扫码加入交流群
上一页
概述
下一页
资源介绍
Built with