# @flink-app/whatsapp-plugin 中文文档

规范地址：https://npmcn.com/package/%40flink-app/whatsapp-plugin/

版本：2\.0\.0-alpha\.134
npm 元数据更新时间：2026-11-07T11:33:32.026Z
中文译文更新时间：2026-11-15T04:43:52.075Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flink-app/whatsapp-plugin
原文对照：https://npmcn.com/package/%40flink-app/whatsapp-plugin/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：118 kB，37 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@flink-app/flink \>=2\.0\.0-alpha\.134
- 首次发布：2026-03-23T10:57:57.723Z
- 最新版本发布：2026-11-07T11:30:19.742Z
- 近 30 天下载量：2167（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 61 个）

## 中文简介

通过 Cloud API 双向WhatsApp 消息的 Flink 插件, 有自动发现的WhatsappHandler 文件

## 安装

```sh
npm install @flink-app/whatsapp-plugin
```

也可以使用：`pnpm add @flink-app/whatsapp-plugin`、`yarn add @flink-app/whatsapp-plugin`、`bun add @flink-app/whatsapp-plugin`

## README

# @flink-app/ 什么sapp-plugin (英语)

双向WhatsApp消息插件 [闪烁](https://github.com/FrostDigital/flink-framework) 通过"WhatsApp"云API. 没有外部 SDK —— 使用本地 `fetch`。 。 。 .

## 特征

-   自动发现 `WhatsappHandler` 通过 Flink 编译扩展名的文件
-   按消息类型、发送者、文本模式和连接方式匹配
-   发送文本、模板、图像、文档、交互式按钮/列表、位置、反应
-   多连接支持(多功能WhatsApp Business 电话号码)
-   Webhook 签名验证(HMC-SHA256)
-   信件状态跟踪( 发送、 发送、 读取、 失败)
-   提供模板信息支持的24小时对话窗口意识
-   将下行标记为 WhatsApp 格式化转换器
-   发送测试消息的 CLI 工具

## 快速启动

```bash
pnpm add @flink-app/whatsapp-plugin
```

```js
// flink.config.js
const { compilerPlugin } = require("@flink-app/whatsapp-plugin/compiler");
module.exports = { compilerPlugins: [compilerPlugin()] };
```

```typescript
// src/index.ts
import { whatsappPlugin } from "@flink-app/whatsapp-plugin";

new FlinkApp<Ctx>({
    plugins: [
        whatsappPlugin<Ctx>({
            connection: {
                accessToken: process.env.WHATSAPP_ACCESS_TOKEN!,
                phoneNumberId: process.env.WHATSAPP_PHONE_NUMBER_ID!,
                verifyToken: process.env.WHATSAPP_VERIFY_TOKEN!,
                appSecret: process.env.WHATSAPP_APP_SECRET!,
            },
        }),
    ],
});
```

```typescript
// src/whatsapp-handlers/HandleText.ts
import { WhatsappHandler, WhatsappRouteProps } from "@flink-app/whatsapp-plugin";

export const Route: WhatsappRouteProps = { type: "text" };

const handler: WhatsappHandler<Ctx> = async ({ message, whatsapp }) => {
    await whatsapp.reply(message, `Echo: ${message.text}`);
};

export default handler;
```

## 文档

见 [技能文档](https://npmcn.com/package/skills/flink-whatsapp-plugin/SKILL.md) 包括路由、多连接设置、模板信息、交互式信息、媒体处理等等.

## Meta 应用程序设置

1.  创建 Meta App 时 [开发者. facebook.com](https://developers.facebook.com/)
2.  添加WhatsApp 产品
3.  配置 Webhook URL 为 `https://your-domain.com/webhooks/whatsapp`
4.  订阅 `messages` 网点字段
5.  通过系统用户生成永久访问令牌

## 国 际

```bash
pnpm exec flink-whatsapp send --token <token> --phone-id <id> --to <number> "Hello!"
```

## 许可证

麻省理工学院

## 常见问题

### @flink-app/whatsapp-plugin 是什么？

通过 Cloud API 双向WhatsApp 消息的 Flink 插件, 有自动发现的WhatsappHandler 文件

### 如何安装 @flink-app/whatsapp-plugin？

在项目目录运行 npm install @flink-app/whatsapp-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@flink-app/flink（\>=2\.0\.0-alpha\.134）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 flink-whatsapp，可以用 npx flink-whatsapp 直接运行。

### @flink-app/whatsapp-plugin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @flink-app/whatsapp-plugin 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @flink-app/whatsapp-plugin 可以商用吗？

@flink-app/whatsapp-plugin 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @flink-app/whatsapp-plugin 的下载量有多少？

根据 npm 官方下载统计，@flink-app/whatsapp-plugin 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,167 次，日均约 72 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @flink-app/whatsapp-plugin 还在维护吗？

最新版本 2\.0\.0-alpha\.134 发布于 2026/11/07（8 天前）；至今共发布 61 个版本，其中过去 12 个月发布了 61 个；首次发布于 2026/03/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。