Lark 类型参考
约 655 字大约 2 分钟
2026-03-28
飞书 (Lark) 平台专用类型 — Sender、枚举、事件数据模型。
Quick Reference
from ncatbot.types.lark import (
LarkSender,
LarkPostType, LarkMessageType, LarkNoticeType,
LarkMessageEventData,
LarkGroupMessageEventData,
LarkPrivateMessageEventData,
LarkMessageReadEventData,
LarkMessageRecalledEventData,
)类型架构
ncatbot.types.lark
├── enums.py # LarkPostType, LarkMessageType, LarkNoticeType
├── sender.py # LarkSender
└── events.py # 事件数据模型（Pydantic）枚举类型
LarkPostType
事件的顶层分类。
| 值 | 说明 |
|---|---|
"message" | 消息事件 |
"notice" | 通知事件 |
LarkMessageType
消息事件子分类。
| 值 | 说明 |
|---|---|
"private" | 私聊消息 |
"group" | 群消息 |
LarkNoticeType
通知事件子分类。
| 值 | 说明 |
|---|---|
"message_read" | 消息已读 |
"message_recalled" | 消息撤回 |
LarkSender
飞书消息发送者信息。继承 BaseSender。
class LarkSender(BaseSender):
open_id: Optional[str] = None
union_id: Optional[str] = None
tenant_key: Optional[str] = None| 字段 | 类型 | 说明 |
|---|---|---|
user_id | str | 用户 ID（继承自 BaseSender） |
nickname | str | 用户昵称（继承自 BaseSender） |
open_id | str | None | 飞书 open_id（应用内唯一） |
union_id | str | None | 飞书 union_id（跨应用唯一） |
tenant_key | str | None | 租户标识 |
事件数据模型
所有事件数据模型均继承 BaseEventData（Pydantic BaseModel），由 LarkEventParser 生成，经工厂函数转换为事件实体。
LarkMessageEventData（基类）
| 字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
platform | str | "lark" | 平台标识 |
post_type | str | "message" | 事件分类 |
message_type | str | "" | 消息子类型 |
message_id | str | "" | 消息 ID |
chat_id | str | "" | 会话 ID |
chat_type | str | "" | 会话类型（"group" / "p2p"） |
content | str | "" | 消息文本 |
message | MessageArray | MessageArray() | 消息数组 |
sender | LarkSender | None | None | 发送者 |
user_id | str | "" | 发送者 open_id |
LarkGroupMessageEventData
继承 LarkMessageEventData。
| 额外字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
message_type | str | "group" | 固定为 group |
group_id | str | "" | 群 chat_id |
LarkPrivateMessageEventData
继承 LarkMessageEventData。
| 额外字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
message_type | str | "private" | 固定为 private |
LarkMessageReadEventData
消息已读通知数据。
| 字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
platform | str | "lark" | 平台标识 |
post_type | str | "notice" | 事件分类 |
notice_type | str | "message_read" | 通知子类型 |
message_id_list | List[str] | [] | 被阅读的消息 ID 列表 |
reader_open_id | str | "" | 阅读者 open_id |
reader_union_id | str | "" | 阅读者 union_id |
reader_user_id | str | "" | 阅读者 user_id |
read_time | str | "" | 阅读时间 |
tenant_key | str | "" | 租户 key |
LarkMessageRecalledEventData
消息撤回通知数据。
| 字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
platform | str | "lark" | 平台标识 |
post_type | str | "notice" | 事件分类 |
notice_type | str | "message_recalled" | 通知子类型 |
message_id | str | "" | 被撤回的消息 ID |
chat_id | str | "" | 所在会话 ID |
recall_time | str | "" | 撤回时间 |
recall_type | str | "" | 撤回类型 |
配置模型
LarkConfig
飞书适配器配置（Pydantic BaseModel）。
from ncatbot.adapter.lark.config import LarkConfig| 字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
app_id | str | "" | 飞书应用 App ID |
app_secret | str | "" | 飞书应用 App Secret |
verification_token | str | "" | 事件验证 Token |
encrypt_key | str | "" | 事件加密 Key |
交叉引用
| 如果你在找… | 去这里 |
|---|---|
| 飞书事件实体 | Lark 事件 |
| 飞书 Bot API | Lark API |
| 通用消息段 | 通用消息段 |
| MessageArray | 消息数组 |
版权所有
版权归属：GEYUANwuqi