README

Telegram API 库

这是一个 PHP7 机器人 API 实现，实现了直到 v4.7 版本的大多数 Bot API。它没有实现的是 Telegram Passport，该功能是在 Bot API v4.0 中引入的。由于可能引入安全漏洞，因此不太可能引入。但是，如果您认为有充分的理由需要它，请随时告诉我。

关于此包

使您能够通过 PHP 将 Telegram Bot API 支持的所有内容发送给 Telegram 用户（无论是直接对话、频道、群组还是超群）。
尊重并实现了 Telegram 本身创建的默认类型和方法。对任何方法有疑问？请查看原始文档，此实现不会相差太多。
不需要任何强制依赖项，除了 ReactPHP，如果您已经在其他地方使用它，则可以注入它。
完全支持内联机器人。
完全支持支付系统。

已知错误

此库（目前）不包括的是 Passport 支持。这是一个持续开发的项目，但最终发现工作量比最初想象的要大得多，因此如果您想接手这个项目，请随意。

其他所有已知错误都可以以问题或拉取请求的形式找到。发现了新的错误？请随时提交 PR或创建问题！不确定是否发现了新的错误？您可以在特殊群组中提问 :)

路线图

v4（尚未创建分支）将是下一个主要版本。更多信息。
v3（master 分支）是当前活动分支。
v2（v2 分支）已弃用，不再对其进行新工作。
v1 已弃用，不再对其进行新工作。
v0 已弃用，不再对其进行新工作。

安装

Composer 是 PHP 中的依赖项管理工具。它允许您声明项目依赖的库，并将为您管理（安装/更新）它们。阅读此处的安装说明。
首选（也是目前唯一）的安装方法是 Composer，因此请将以下内容添加到您的 composer.json 中

{
  "require": {
    "unreal4u/telegram-api": "~3.4"
  }
}

如果您不熟悉它，我建议您阅读位于此处的基本用法手册。

针对俄罗斯用户的提示

为了使用代理，您可以使用 https://github.com/clue/php-socks-react 包，并将以下选项传递给 Client

<?php

use Clue\React\Socks\Client;

$loop = Factory::create();
// Replace PROXY_ADDRESS and PROXY_PORT with the correct configuration
$proxy = new Client('socks5://' . PROXY_ADDRESS . ':' . PROXY_PORT, new Connector($loop));
$handler = new HttpClientRequestHandler($loop, [
    'tcp' => $proxy,
    'timeout' => 3.0,
    'dns' => false
]);

$this->tgLog = new TgLog(BOT_TOKEN, $handler);
// The rest is exactly the same as it normally is, see the examples folder for more information

通过这些简单的步骤，您可以在瞬间配置代理！

将 v2.x 升级到 v3

有很多向后不兼容的更改，但总的来说

ReactPHP是新的Guzzle（异步请求！）
在调用TgLog构造函数时改变了参数顺序
自定义-Array类型现在实现IteratorAggregate（解决了#21！）

如果您需要从v2升级到v3，请检查以下维基页面：升级说明

通用用法

基本用法示例

<?php

use \unreal4u\TelegramAPI\HttpClientRequestHandler;
use \unreal4u\TelegramAPI\TgLog;
use \unreal4u\TelegramAPI\Telegram\Methods\SendMessage;

$loop = \React\EventLoop\Factory::create();
$handler = new HttpClientRequestHandler($loop);
$tgLog = new TgLog(BOT_TOKEN, $handler);

$sendMessage = new SendMessage();
$sendMessage->chat_id = A_USER_CHAT_ID;
$sendMessage->text = 'Hello world!';

$tgLog->performApiRequest($sendMessage);
$loop->run();

（侧注：如果在上面的代码中无法解析React\EventLoop\Factory，请将include('vendor/autoload.php')添加到您的PHP文件中）。

使用SendMessage对象，您可以通过TgLog对象创建要发送的消息。
所有其他功能都是基于此行为，因此其他方法非常相似：您实例化一个对象，将对象传递给TelegramLog->performApiRequest()，这将返回一个Promise。如果方法返回回复，将回调传递给其onFulfilled参数，您将作为对象返回本地的Telegram响应。不同方法返回不同类型的对象。

请参阅示例目录，查看实现的一些方法示例，包括内联机器人。

有关实际在生产环境中工作的代码示例，请参阅我的其他存储库：https://github.com/unreal4u/telegram-bots

通过Webhook获取更新

有关更多此信息，请参阅以下维基部分：Webhook获取更新

内联机器人

请查看有关内联机器人的特殊维基页面：内联机器人

额外要求

如果您想使用此包，您需要一个机器人API密钥。有关详细信息，请参阅以下文档：创建机器人

启动一切

使用Telegram API执行操作时最困难的事情是获取chat_id，这是机器人实际对话的窗口。您可以通过执行GetUpdates()方法来获取此chatId。请注意，这里有一些注意事项，因此您可能更适合使用SetWebhook()方法。

开发

语义化版本控制

我将尽力尊重语义化版本控制。
话虽如此，第一个稳定版本是v1.0.0，从那里开始，除非我们更新主版本，否则不会发生重大的BC更改。

想要合作吗？

合作是非常欢迎的！请查看以下维基页面以获取使开发更容易的信息：合作信息

联系作者

我实际上没有使用Telegram。哈哈，开玩笑的，我创建了一个您可以联系我的群组https://t.me/PHPBotAPI。另一种很好的联系方式是简单地创建问题或拉取请求！

与安全相关的错误

如果您能够负责任地处理这些问题，我将非常感激。如果您偶然发现与这个Telegram Bot API客户端相关的安全问题，请让我通过这里私下联系您。

特别感谢

👍 对NanoSector表示非常感谢，他为整个API的异步化做出了贡献！
👍 增强用于报告此致命错误。
👍 所有创建问题和拉取请求的神奇的人们！

dnezh / telegram-api

维护者

详情