复制页面

飞书 API

• 应用权限
  • 简介
  • 权限列表
• API 调用指南
  • API 列表
  • 频控策略
  • 通用参数
  • 通用错误码
  • 调用流程
    • 流程概述
    • 获取访问凭证
    • 申请 API 权限
    • 配置应用数据权限
    • 设置 IP 白名单
    • 调用 API
• 事件与回调
  • 事件订阅
    • 事件概述
    • 事件列表
    • 常见问题
    • 事件订阅优化指南
    • 订阅流程
      • 步骤一：使用长连接接收事件
      • 步骤一：将事件发送至开发者服务器
      • 步骤二：添加事件
      • 步骤三：接收事件
    • 获取事件出口 IP
  • 回调订阅
    • 回调概述
    • 步骤一：选择订阅方式（使用长连接接收回调）
    • 步骤一：选择订阅方式（将回调发送至开发者服务器）
    • 步骤二：添加回调
    • 步骤三：接收回调
• 服务端 SDK
  • 服务端 SDK
  • 常见问题
  • Java SDK 指南
    • 开发前准备
    • 调用服务端 API
    • 处理事件
    • 处理回调
    • 场景示例
  • Golang SDK 指南
    • 开发前准备
    • 调用服务端 API
    • 处理事件
    • 处理回调
    • 场景示例
  • Python SDK 指南
    • 开发前准备
    • 调用服务端 API
    • 处理事件
    • 处理回调
    • 场景示例
  • NodeJS SDK 指南
    • 开发前准备
    • 调用服务端 API
    • 处理事件
    • 处理回调
    • 场景示例
• 认证及授权
  • 登录态管理
    • 资源介绍
    • 获取登录用户信息
    • 批量获取脱敏的用户登录信息
    • 退出登录
  • 获取访问凭证
    • 自建应用获取 tenant_access_token
    • 自建应用获取 app_access_token
    • 获取 user_access_token
    • 商店应用获取 app_access_token
    • 刷新 user_access_token
    • 重新获取 app_ticket
    • 商店应用获取 tenant_access_token
• 通讯录
  • 概述
  • 常见问题
  • 权限范围
    • 权限范围资源介绍
    • 事件
      • 通讯录权限范围变更
    • 通讯录权限范围变更
  • 用户
    • 资源介绍
    • 国家/地区 Code 参照表
    • 事件
      • 员工信息被修改
      • 员工离职
      • 员工入职
    • 创建用户
    • 删除用户
    • 修改用户部分信息
    • 获取单个用户信息
    • 更新用户所有信息
    • 获取单个用户信息
    • 获取部门直属用户列表
    • 通过手机号或邮箱获取用户 ID
  • 用户组
    • 资源介绍
    • 创建用户组
    • 删除用户组
    • 更新用户组
    • 查询指定用户组
    • 查询用户组列表
    • 查询用户所属用户组
  • 自定义用户字段
    • 资源介绍
    • 事件
      • 成员字段变更
    • 获取企业自定义用户字段
  • 人员类型
    • 资源介绍
    • 事件
      • 新建人员类型
      • 启用人员类型
      • 停用人员类型
      • 删除人员类型
      • 修改人员类型名称
    • 新增人员类型
    • 删除人员类型
    • 更新人员类型
    • 查询人员类型
  • 部门
    • 资源介绍
    • 事件
      • 创建部门
      • 删除部门
      • 修改部门信息
    • 创建部门
    • 删除部门
    • 修改部门部分信息
    • 获取单个部门信息
    • 更新部门所有信息
    • 部门群转为普通群
    • 获取单个部门信息
    • 获取子部门列表
    • 获取父部门信息
    • 搜索部门
  • 单位
    • 资源介绍
    • 创建单位
    • 删除单位
    • 修改单位信息
    • 建立部门与单位的绑定关系
    • 解除部门与单位的绑定关系
    • 获取单位绑定的部门列表
    • 获取单位信息
    • 获取单位列表
  • 用户组成员
    • 资源介绍
    • 添加用户组成员
    • 批量添加用户组成员
    • 移除用户组成员
    • 查询用户组成员列表
    • 批量移除用户组成员
• 事件管理
  • 获取事件出口 IP
• 消息
  • 概述
  • 常见问题
  • 消息内容介绍
    • 发送消息内容
    • 接收消息内容
  • 消息管理
    • 资源介绍
    • 事件
      • 接收消息
      • 消息已读
      • 撤回消息
    • 发送消息
    • 回复消息
    • 撤回消息
    • 查询消息已读信息
    • 获取会话历史消息
    • 获取消息中的资源文件
    • 获取指定消息的内容
  • 消息加急
    • 发送应用内加急
    • 发送短信加急
    • 发送电话加急
  • 批量消息
    • 批量发送消息
    • 批量撤回消息
    • 查询批量消息推送和阅读人数
    • 查询批量消息整体进度
  • 图片信息
    • 上传图片
    • 下载图片
  • 文件信息
    • 上传文件
    • 下载文件
  • 消息-消息卡片
    • 资源介绍
    • 更新应用发送的消息卡片
    • 延时更新消息卡片
    • 发送仅特定人可见的消息卡片
    • 删除仅特定人可见的消息卡片
  • 表情回复
    • 资源介绍
    • 表情文案说明
    • 事件
      • 新增消息表情回复
      • 删除消息表情回复
    • 添加消息表情回复
    • 删除消息表情回复
    • 获取消息表情回复
  • Pin
    • Pin 消息
    • 移除 Pin 消息
    • 获取群内 Pin 消息
• 群组
  • 概述
  • 群组管理
    • 资源介绍
    • 群 ID 说明
    • 事件
      • 群解散
      • 群配置修改
    • 创建群
    • 解散群
    • 更新群信息
    • 更新群发言权限
    • 获取群信息
    • 更新群置顶
    • 撤销群置顶
    • 获取用户或机器人所在的群列表
    • 搜索对用户或机器人可见的群列表
    • 获取群成员发言权限
    • 获取群分享链接
  • 群成员
    • 资源介绍
    • 事件
      • 用户进群
      • 用户出群
      • 撤销拉用户进群
      • 机器人进群
      • 机器人被移出群
      • 用户和机器人的会话首次被创建
    • 指定群管理员
    • 删除群管理员
    • 将用户或机器人拉入群聊
    • 用户或机器人主动加入群聊
    • 将用户或机器人移出群聊
    • 获取群成员列表
    • 判断用户或机器人是否在群里
  • 群公告
    • 资源介绍
    • 更新群公告信息
    • 获取群公告信息
  • 会话标签页
    • 添加会话标签页
    • 删除会话标签页
    • 更新会话标签页
    • 会话标签页排序
    • 拉取会话标签页
  • 群菜单
    • 资源介绍
    • 添加群菜单
    • 删除群菜单。
    • 修改群菜单元信息
    • 排序群菜单
    • 获取群菜单
• 云文档
  • 概述
  • 常见问题
  • 云空间
    • 云空间概述
    • 云空间常见问题
    • 文件夹
      • 获取我的空间（root folder）元信息
      • 获取文件夹下的清单
      • 获取文件夹元信息
      • 移动文件
      • 删除文件
    • 文件
      • 异步任务状态
        • 查询异步任务状态
      • 获取文档元数据
      • 新建在线文档
      • 复制文件
      • 移动文件
      • 删除文件
      • 获取文件统计信息
    • 素材
      • 素材概述
      • 分片上传素材
        • 概述
        • 分片上传素材（预上传）
        • 分片上传素材（上传分片）
        • 分片上传素材（完成上传）
      • 上传素材
      • 下载素材
      • 获取素材临时下载链接
    • 事件
      • 列表
        • 多维表格字段变更
        • 多维表格记录变更
        • 文件标题变更
        • 文件已读
        • 文件编辑
        • 文件协作者添加
        • 文件协作者移除
        • 文件删除到回收站
        • 文件彻底删除
      • 订阅云文档事件
    • 搜索
      • 文档搜素
    • 上传
      • 分片上传文件
        • 概述
        • 分片上传文件（预上传）
        • 分片上传文件（上传分片）
        • 分片上传文件（完成上传）
      • 上传文件
    • 下载
      • 下载文件
    • 导入
      • 概述
      • 创建导入任务
      • 查询导入结果
    • 导出
      • 导出文件指南
      • 创建导出任务
      • 查询导出任务结果
      • 下载导出文件
    • 文档版本
      • 概述
      • 创建文档版本
      • 删除文档版本
      • 获取文档版本
      • 获取文档版本列表
  • 权限
    • 权限概述
    • 常见问题
    • 成员
      • 转移所有者
      • 判断当前用户是否有某权限
      • 获取协作者列表（新版本）
      • 获取协作者列表
      • 增加协作者权限
      • 更新协作者权限
      • 移除协作者权限
    • 设置
      • 获取云文档权限设置
      • 更新云文档权限设置
  • 评论
    • 分页获取文档评论
    • 添加评论
    • 获取评论
    • 更新回复
    • 删除回复
    • 解决/恢复 评论
  • 文档
    • 新版文档接入指南
    • 新版文档
      • 概述
      • 数据结构
      • 接入指南
      • 文档
        • 获取文档基本信息
        • 获取文档纯文本内容
        • 获取文档所有块
        • 创建文档
      • 块
        • 获取块
        • 创建块
        • 更新块
        • 批量更新块
        • 删除块
        • 获取所有子块
    • 旧版文档
      • 概述
      • 准备接入文档 API
      • 文档数据结构概述
      • 文档数据结构参考
      • 文档
        • 创建文档
      • 内容
        • 获取文档富文本内容
        • 获取文档文本内容
        • 编辑文档内容
  • 权限
    • 权限成员
      • 增加权限
      • 判断协作者是否有某权限
    • 权限设置
      • 获取文档公共设置V2
      • 更新文档公共设置
    • 转移拥有者
  • 电子表格
    • 概述
    • 电子表格常见问题
    • 支持写入的数据类型
    • 支持数字格式类型
    • 表格
      • 修改电子表格属性
      • 获取电子表格信息
      • 创建表格
    • 工作表
      • 查询工作表
      • 获取工作表
      • 操作工作表
      • 更新工作表属性
    • 行列
      • 增加行列
      • 插入行列
      • 更新行列
      • 移动行列
      • 删除行列
    • 单元格
      • 追加数据
      • 插入数据
      • 读取单个范围
      • 读取多个范围
      • 向单个范围写入数据
      • 向多个范围写入数据
      • 设置单元格样式
      • 批量设置单元格样式
      • 写入图片
      • 合并单元格
      • 拆分单元格
      • 查找单元格
      • 替换单元格
    • 筛选
      • 筛选指南
      • 获取筛选
      • 创建筛选
      • 更新筛选
      • 删除筛选
    • 筛选视图
      • 筛选条件
        • 筛选视图的筛选条件指南
        • 创建筛选条件
        • 查询筛选条件
        • 更新筛选条件
        • 删除筛选条件
        • 获取筛选条件
      • 更新筛选视图
      • 获取筛选视图
      • 查询筛选视图
      • 创建筛选视图
      • 删除筛选视图
    • 表格操作
      • 创建表格
      • 获取表格元数据
      • 更新表格属性
      • 操作工作表
      • 更新工作表属性
    • 保护范围
      • 增加保护范围
      • 获取保护范围
      • 修改保护范围
      • 删除保护范围
    • 数据校验
      • 概述
      • 设置下拉列表
      • 删除下拉列表设置
      • 更新下拉列表设置
      • 查询下拉列表设置
    • 条件格式
      • 条件格式指南
      • 创建条件格式
      • 获取条件格式
      • 更新条件格式
      • 删除条件格式
    • 浮动图片
      • 浮动图片指南
      • 创建浮动图片
      • 获取浮动图片
      • 查询浮动图片
      • 更新浮动图片
      • 删除浮动图片
  • API参考
    • 创建文档
    • 编辑文档内容
    • 历史文档（不建议）
      • 获取文档中的电子表格的元数据
    • 获取文档元信息
  • 多维表格
    • 概述
    • 接入指南
    • 数据结构
    • 多维表格
      • 获取多维表格元数据
      • 更新多维表格元数据
    • 数据表
      • 更新数据表
      • 列出数据表
      • 新增数据表
      • 新增多个数据表
      • 删除一个数据表
      • 删除多个数据表
    • 仪表盘
      • 复制仪表盘
      • 列出仪表盘
    • 视图
      • 更新视图
      • 检索视图
      • 列出视图
      • 新增视图
      • 删除视图
    • 表单
      • 更新表单元数据
      • 获取表单元数据
      • 更新表单问题
      • 列出表单问题
    • 记录
      • 记录筛选开发指南
      • 检索记录
      • 列出记录
      • 新增记录
      • 更新记录
      • 删除记录
      • 新增多条记录
      • 更新多条记录
      • 删除多条记录
    • 字段
      • 字段编辑指南
      • 附件字段说明
      • 列出字段
      • 新增字段
      • 更新字段
      • 删除字段
    • 高级权限
      • 概述
      • 自定义角色
        • 列出自定义角色
        • 新增自定义角色
        • 删除自定义角色
        • 更新自定义角色
      • 协作者
        • 批量删除协作者
        • 批量新增协作者
        • 列出协作者
        • 新增协作者
        • 删除协作者
  • 知识库
    • 概述
    • 常见问题
    • 知识空间
      • 创建知识空间
      • 获取知识空间列表
      • 获取知识空间信息
    • 空间成员
      • 删除知识空间成员
      • 添加知识空间成员
    • 空间设置
      • 更新知识空间设置
    • 节点
      • 创建知识空间节点
      • 获取知识空间节点信息
      • 获取知识空间子节点列表
      • 移动知识空间节点
      • 更新知识空间节点标题
      • 创建知识空间节点副本
    • 任务
      • 获取任务结果
    • 云文档
      • 移动云空间文档至知识空间
      • 获取任务结果
    • 搜索 Wiki
      • 搜索 Wiki
  • 云文档助手
    • 订阅
      • 获取订阅状态
      • 创建订阅
      • 更新订阅状态
• 日历
  • 概述
  • 常见问题
  • 日历管理
    • 资源介绍
    • 事件
      • 日历变更
    • 获取主日历
    • 创建共享日历
    • 删除共享日历
    • 查询主日历信息
    • 查询主日历忙闲信息
    • 查询日历信息
    • 查询日历列表
    • 更新日历
    • 搜索日历
    • 订阅日历
    • 取消订阅日历
    • 订阅日历变更事件
    • 取消订阅日历变更事件
  • 日历访问控制
    • 资源介绍
    • 事件
      • 创建 ACL
      • 删除 ACL
    • 取消订阅日历访问控制变更事件
    • 创建访问控制
    • 删除访问控制
    • 获取访问控制列表
    • 订阅日历访问控制变更事件
  • 日程管理
    • 资源介绍
    • 事件
      • 日程变更
    • 创建日程
    • 删除日程
    • 更新日程
    • 获取日程
    • 获取日程列表
    • 搜索日程
    • 订阅日程变更事件
    • 取消订阅日程变更事件
  • 请假日程管理
    • 资源介绍
    • 创建请假日程
    • 删除请假日程
  • 会议室日程管理
    • 事件
      • 会议室状态信息变更
      • 第三方会议室日程变动
    • 查询会议室日程主题和会议详情
    • 查询会议室忙闲
    • 回复会议室日程实例
  • 日程参与人
    • 资源介绍
    • 获取日程参与群成员列表
    • 添加日程参与人
    • 获取日程参与人列表
    • 删除日程参与人
  • 同步到本地日历
    • 生成 CalDAV 配置
  • 同步 Exchange 日历信息
    • 资源介绍
    • 将 Exchange 账户绑定到飞书账户
    • 解除 Exchange 账户绑定
    • 查询 Exchange 账户的绑定状态
• 视频会议
  • 视频会议概述
  • 预约
    • 资源介绍
    • 预约会议
    • 删除预约
    • 更新预约
    • 获取预约
    • 获取活跃会议
  • 会议
    • 资源介绍
    • 事件
      • 企业会议开始
      • 企业会议结束
      • 会议开始
      • 会议结束
      • 加入会议
      • 离开会议
      • 开始录制
      • 停止录制
      • 录制完成
      • 屏幕共享开始
      • 屏幕共享结束
    • 邀请参会人
    • 移除参会人
    • 设置主持人
    • 结束会议
    • 获取会议详情
    • 获取与会议号相关联的会议列表
  • 录制
    • 资源介绍
    • 开始录制
    • 停止录制
    • 获取录制文件
    • 授权录制文件
  • 会议报告
    • 资源介绍
    • 获取会议报告
    • 获取top用户列表
  • 导出
    • 资源介绍
    • 导出会议明细
    • 导出参会人明细
    • 导出参会人会议质量数据