Skip to content

飞书卡片资源概述

飞书卡片是应用的一种能力,包括构建卡片内容所需的组件和发送卡片所需的能力,并提供了可视化搭建工具。飞书开放平台针对飞书卡片提供了一系列 OpenAPI,使用这些 OpenAPI 你可以在卡片和组件维度,局部或流式更新卡片。

典型案例

开放平台提供了包含飞书卡片的案例,详情可参见:

接入流程

卡片 API 的基本接入流程如下图所示,如需了解详细的 API 接入流程,参见流程概述

开发指南

资源介绍

飞书卡片 OpenAPI 中,以卡片和组件资源为中心开放接口,支持创建、更新卡片。

资源描述
卡片飞书卡片能将结构化的内容以卡片形式嵌入至聊天消息、群置顶消息、链接预览等飞书协作场景中,提升信息传递效率。了解更多参见飞书卡片概述。通过卡片实体 API,你可从卡片维度创建卡片、更新卡片。
组件飞书卡片中的组件可分为容器类、展示类和交互类组件。了解更多参见组件概述。通过组件 API,你可以在一张卡片中新增、修改组件。

方法列表

以下提供创建和更新卡片的 API 列表。你可通过创建卡片实体接口创建卡片,再调用发送消息接口通过卡片 ID 发送卡片。之后使用其它接口局部更新卡片。

Tip: - 下表中 商店 是指商店应用,自建 是指企业自建应用。应用类型说明参见应用类型简介

卡片级

方法 (API)权限要求(满足任一)访问凭证商店自建
``POST[创建卡片实体](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/create) open-apis/cardkit/v1/cardscardkit:card:write 创建与更新卡片tenant_access_token
``PUT [全量更新卡片实体](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/update) /open-apis/cardkit/v1/cards/:card_idcardkit:card:write 创建与更新卡片tenant_access_token
``PATCH [更新卡片配置](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings) /open-apis/cardkit/v1/cards/:card_id/settingscardkit:card:write 创建与更新卡片tenant_access_token
``POST [批量更新卡片实体](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update) /open-apis/cardkit/v1/cards/:card_id/batch_updatecardkit:card:write 创建与更新卡片tenant_access_token

组件级

方法 (API)权限要求(满足任一)访问凭证商店自建
``POST[新增组件](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/create) /open-apis/cardkit/v1/cards/:card_id/elementscardkit:card:write 创建与更新卡片tenant_access_token
``PUT [更新组件](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/update) /open-apis/cardkit/v1/cards/:card_id/elements/:element_idcardkit:card:write 创建与更新卡片tenant_access_token
``PATCH [更新组件属性](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/patch) /open-apis/cardkit/v1/cards/:card_id/elements/:element_idcardkit:card:write 创建与更新卡片tenant_access_token
``PUT [流式更新文本](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/content) /open-apis/cardkit/v1/cards/:card_id/elements/:element_id/contentcardkit:card:write 创建与更新卡片tenant_access_token
``DELETE [删除组件](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/delete) /open-apis/cardkit/v1/cards/:card_id/elements/:element_idcardkit:card:write 创建与更新卡片tenant_access_token

内容来源:飞书开放平台 · 自动爬取整理