概述 - 飞书 API

业务介绍

飞书提供了一系列即时通讯场景的API。通过创建飞书机器人并调用消息与群组API，你可以实现多种功能，例如：

通过飞书发送不同类型的消息，如文本、富文本、图片、文件、互动消息卡片、视频、音频和表情符号。

管理飞书群组，例如创建群组、添加用户或机器人到群组。

更多应用场景可参考客户案例：

接入流程

	步骤	介绍
1	创建一个应用	如需创建企业自建应用，可参考自建应用的开发流程如需创建应用商店应用，可参考开发和上架应用商店应用
2	调用API，对消息或群组进行操作	调用API前，你需要先获取访问凭证并开启对应的权限，详情参见如何调用服务端API你还可以在 API 调试台中快速调试这些 API ，使用方法参见API 调试台使用指南。
3	监听事件，获知消息或群组的变化	监听事件前，你需要先申请相应的权限，详情参见事件订阅概述

开发教程

快速入门场景教学
机器人自动拉群报警	向指定部门进行消息群发
新人入群欢迎机器人	基于会话的互动机器人
互动型消息卡片发送（审批卡片）

发送不同类型的飞书消息。如文本、富文本、图片、文件、可交互的消息卡片、视频、音频、表情等；

进行飞书群组管理。如创建群组、拉用户或机器人入群。

资源介绍

消息与群组业务域以“资源”为中心进行开放，资源的关系图如下：

上图中用户 User 资源属于通讯录业务范围，可打开通讯录文档查看详情。

消息与群组的相关资源定义如下：

资源	资源定义
消息	通过IM发送的一段信息，类型包括文本、富文本、卡片、群名片、个人名片、图片、视频、文件等。
消息 - 图片	承载图片信息的静态资源。
消息 - 文件	承载文件信息的静态资源。
消息 - 消息卡片	可以承载丰富的图文内容和交互行为的消息类型。
消息 - 表情回复	飞书消息的表情回复。
群信息	飞书中的聊天群组。
群组 - 群成员	群组内成员（包括用户和机器人）的集合，用于描述群组和成员的关系。
群组 - 群公告	群组中的公告文档。

以下将详细介绍每个资源的字段、方法、事件。

“商店”代表应用商店应用，“自建”代表企业自建应用，请参考应用类型说明。

资源：消息

查看资源字段及示例

方法列表

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）
发送消息`POST` /open-apis/im/v1/messages给指定用户或者会话发送消息，支持文本、富文本、卡片、群名片、个人名片、图片、视频、音频、文件、表情包。	获取与发送单聊、群组消息	tenant_access_token	✓	✓
批量发送消息`POST` /open-apis/message/v4/batch_send/给多个用户或者多个部门发送消息。	给多个用户批量发消息给一个或多个部门的成员批量发消息	tenant_access_token	✓	✓
回复消息`POST` /open-apis/im/v1/messages/:message_id/reply回复指定消息，支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。	获取与发送单聊、群组消息	tenant_access_token	✓	✓
撤回消息`DELETE` /open-apis/im/v1/messages/:message_id机器人撤回机器人自己发送的消息或群主撤回群内消息。	获取与发送单聊、群组消息	tenant_access_tokenuser_access_token	✓	✓
查询消息已读信息`GET` /open-apis/im/v1/messages/:message_id查询消息的已读信息。	获取单聊、群组消息获取与发送单聊、群组消息	tenant_access_token	✓	✓
获取会话历史消息`GET` /open-apis/im/v1/messages获取会话（包括单聊、群组）的历史消息。	获取与发送单聊、群组消息获取单聊、群组消息	tenant_access_token	✓	✓
获取消息中的资源文件`GET` /open-apis/im/v1/messages/:message_id/resources/:file_key获取消息中的资源文件，包括音频，视频，图片和文件，暂不支持表情包资源下载。当前仅支持 100M 以内的资源文件的下载。	获取与发送单聊、群组消息获取单聊、群组消息	tenant_access_token	✓	✓
获取指定消息的内容`GET` /open-apis/im/v1/messages/:message_id通过 message_id 查询消息内容	获取单聊、群组消息获取与发送单聊、群组消息	tenant_access_token	✓	✓

事件列表

	事件 (Event)	触发时机	权限要求（满足任一）	事件类型	商店	自建
接收消息	机器人接收到用户发送的消息后触发此事件。	获取与发送单聊、群组消息获取单聊、群组消息	im.message.receive_v1	✓	✓
消息已读	用户阅读机器人发送的单聊消息后触发此事件。	获取单聊、群组消息获取与发送单聊、群组消息	im.message.message_read_v1	✓	✓

资源：消息 - 图片

资源字段及示例

	名称	类型		描述
image_key	string	图片的key

{
    "image_key": "img_v2_b99741-7628-4abd-aad0-b881e4db83ig"
}

方法列表

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）	商店	自建
上传图片`POST` /open-apis/im/v1/images上传图片接口，可以上传 JPEG、PNG、WEBP 格式图片。	获取与上传图片或文件资源	tenant_access_token	✓	✓
下载图片`GET` /open-apis/im/v1/images/:image_key下载图片资源，只能下载应用自己上传且图片类型为message的图片。	无	tenant_access_token	✓	✓

资源：消息 - 文件

	名称	类型		描述
file_key	string	文件的key

{
    "file_key": "file_456a92d6-c6ea-4de4-ac3f-7afcf44ac78g"
}

方法列表

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）	商店	自建
上传文件`POST` /open-apis/im/v1/files上传文件，可以上传视频，音频和常见的文件类型。	获取与上传图片或文件资源	tenant_access_token	✓	✓
下载文件`GET` /open-apis/im/v1/files/:file_key下载文件接口，只能下载应用自己上传的文件。	无	tenant_access_token	✓	✓

资源：消息 - 消息卡片

查看资源字段及示例

方法列表

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）
更新应用发送的消息`PATCH` /open-apis/im/v1/messages/:message_id更新应用已发送的消息卡片内容。	获取与发送单聊、群组消息	tenant_access_tokenuser_access_token	✓	✓
消息卡片延迟更新`POST` /open-apis/interactive/v1/card/update用于用户交互完成后延后更新消息卡片	无	tenant_access_token	✓	✓
发送临时卡片消息`POST` /open-apis/ephemeral/v1/send用于机器人在群会话中发送指定用户可见的消息卡片。	无	tenant_access_token	✓	✓
删除临时消息`POST` /open-apis/ephemeral/v1/delete在群会话中删除指定用户的临时消息卡片临时卡片消息可以通过该接口进行显式删除，临时卡片消息删除后将不会在该设备上留下任何痕迹。	无	tenant_access_token	✓	✓

资源：消息 - 表情回复

查看资源字段及示例

方法列表

	方法 (API)	权限要求（满足任一）		访问凭证（选择其一）
添加消息表情回复`POST` /open-apis/im/v1/messages/:message_id/reactions给指定消息添加指定类型的表情回复。	获取与发送单聊、群组消息	tenant_access_tokenuser_access_token	✓	✓
获取消息表情回复`GET` /open-apis/im/v1/messages/:message_id/reactions获取指定消息的特定类型表情回复列表。	获取单聊、群组消息	tenant_access_tokenuser_access_token	✓	✓
删除消息表情回复`DELETE` /open-apis/im/v1/messages/:message_id/reactions/:reaction_id删除指定消息的表情回复。	获取与发送单聊、群组消息	tenant_access_tokenuser_access_token	✓	✓

事件列表

	事件 (Event)	触发时机	权限要求（满足任一）	事件类型	商店	自建
删除消息表情回复	消息被删除某一个表情回复后触发此事件。	获取单聊、群组信息	im.message.reaction.deleted_v1	✓	✓
新增消息表情回复	消息被添加某一个表情回复后触发此事件。	获取单聊、群组信息	im.message.reaction.created_v1	✓	✓

概述

业务介绍#

接入流程#

开发教程#

资源介绍#

资源：消息#

方法列表#

事件列表#

资源：消息 - 图片#

资源字段及示例#

方法列表#

资源：消息 - 文件#

方法列表#

资源：消息 - 消息卡片#

方法列表#

资源：消息 - 表情回复#

方法列表#

事件列表#

业务介绍

接入流程

开发教程

资源介绍

资源：消息

方法列表

事件列表

资源：消息 - 图片

资源字段及示例

方法列表

资源：消息 - 文件

方法列表

资源：消息 - 消息卡片

方法列表

资源：消息 - 表情回复

方法列表

事件列表