npm 包 telehook 使用教程

阅读时长 6 分钟读完

什么是 Telehook?

Telehook 是一个 npm 包,用于将 Webhook 传递到 Telegram bot。它可以将来自任何来源的 Webhook 转发到您的 Telegram bot,并向您发送有关传入 Webhook 请求的详细信息。

Telehook 的特性

  • 快速安装和简单配置;
  • 支持不同的 Webhook 协议;
  • 可以使用自定义模板将 Webhook 数据转发到 Telegram bot;
  • 提供有关传入 Webhook 请求的有用信息,如请求主机、请求路径、HTTP 方法等等。

Telehook 的安装

在终端中运行以下命令即可安装最新版本的 Telehook:

如何使用 Telehook?

创建 Telegram bot 并获取 Bot API Token

首先需要创建一个 Telegram bot。在 Telegram 中,使用 BotFather 创建新的 bot。完成后,BotFather 将向您发送一个 API 令牌,该令牌是使用 Telehook 的必要条件。

创建转发器实例

使用 createTelehook() 函数创建 Telehook 实例。在此过程中,需要提供 Telegram bot 的 API 令牌。

配置转发器

使用 Telehook 的 setConfig() 方法配置转发器设置。此方法接受一个对象,其中包含以下可选参数:

  1. path: Webhook 的路径(默认为 '/telehook');
  2. proxy: Webhook 的代理URL;
  3. template: 使用的消息模板。

添加 Webhook 路由

使用 Express 的 app 对象创建 Webhook 路由,然后使用 Telehook 的 route() 方法添加路由。Telehook 将使用此路由来接收外部 Webhook 请求。

-- -------------------- ---- -------
----- ------- - ------------------

----- --- - ---------

----------------------- ----- ---- -- -
  -- ---
--

-------------------

发送 Webhook 请求

使用其他服务或工具发送 Webhook 请求。Telehook 将此请求转发到您的 Telegram bot。

接收 Telegram 通知

除了将 Webhook 转发到您的 Telegram bot 之外,Telehook 还可以通知您有关传入 Webhook 请求的详细信息。为此,只需添加以下代码:

模板和变量

Telehook 还支持使用自定义模板将 Webhook 数据转发到 Telegram bot。在默认情况下,Telehook 使用以下模板:

这表示,使用 Telehook 时,当 Webhook 被接收并转发到 Telegram 时,将显示类似于以下内容的消息:

New webhook received at /my-webhook from mywebsite.com

您还可以使用变量将 Webhook 数据传递给 Telegram bot。以下是 Telehook 支持的变量列表。

  • {{ request.host }}: Webhook 请求的主机名;
  • {{ request.path }}: Webhook 请求的路径;
  • {{ request.method }}: Webhook 请求的 HTTP 方法;
  • {{ request.headers }}: Webhook 请求的头文件;
  • {{ request.body }}: Webhook 请求体。

Telehook 的高级功能

Telehook 还支持以下高级功能:

自定义转发器

您可以编写自定义转发器以向 Telegram 发送 HTTP 请求。要编写一个自定义转发器,只需使用以下代码:

使用策略配置

您可以使用策略配置来控制哪些 Webhook 请求应该从 Telehook 转发到 Telegram bot。使用 Telehook 的 use() 方法应用策略配置。

使用 Telegram API 客户端

Telehook 包含一个 Telegram API 客户端,可轻松与 Telegram bot 通信。

Telehook 的总结

Telehook 是一个非常有用的 npm 包,可将 Webhook 转发到 Telegram bot。通过此包,可以将 Webhook 请求传递到 Telegram bot,并及时从 Telegram bot 接收有关传入 Webhook 请求的详细信息。Telehook 可以使用自定义模板将 Webhook 数据转发到 Telegram,以及使用策略配置和 Telegram API 客户端等高级功能。Telehook 提供了完整的指导和项目示例。欢迎使用!

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f83238a385564ab6c07

纠错
反馈