nemutaisama/native-telegram-api

基于 https://github.com/TelegramBot/Api 的分支

v2.3.13 2018-04-30 11:46 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

一个无需额外要求的扩展原生 PHP 包装器,用于 Telegram Bot API,支持所有方法和响应类型。

机器人:开发者的介绍

机器人是专门为自动处理消息而设计的特殊 Telegram 账户。用户可以通过在私聊或群聊中发送命令消息与机器人互动。

您可以通过对 bot API 发送 HTTPS 请求来控制您的机器人。

Bot API 是一个基于 HTTP 的接口,专为希望为 Telegram 开发机器人的开发者创建。有关如何创建和设置机器人的信息,请参阅 机器人介绍机器人常见问题解答

安装

通过 Composer

$ composer require telegram-bot/api

使用方法

查看示例 DevAnswerBot(俄语)。

API 包装器

发送消息

$bot = new \TelegramBot\Api\BotApi('YOUR_BOT_API_TOKEN');

$bot->sendMessage($chatId, $messageText);

发送文档

$bot = new \TelegramBot\Api\BotApi('YOUR_BOT_API_TOKEN');

$document = new \CURLFile('document.txt');

$bot->sendDocument($chatId, $document);

发送带有回复键盘的消息

$bot = new \TelegramBot\Api\BotApi('YOUR_BOT_API_TOKEN');

$keyboard = new \TelegramBot\Api\Types\ReplyKeyboardMarkup(array(array("one", "two", "three")), true); // true for one-time keyboard

$bot->sendMessage($chatId, $messageText, null, false, null, $keyboard);

发送带有内联键盘的消息

$bot = new \TelegramBot\Api\BotApi('YOUR_BOT_API_TOKEN');

$keyboard = new \TelegramBot\Api\Types\Inline\InlineKeyboardMarkup(
            [
                [
                    ['text' => 'link', 'url' => 'https://core.telegram.org']
                ]
            ]
        );
        
$bot->sendMessage($chatId, $messageText, null, false, null, $keyboard);

发送媒体组

$bot = new \TelegramBot\Api\BotApi('YOUR_BOT_API_TOKEN');

$media = new \TelegramBot\Api\Types\InputMedia\ArrayOfInputMedia();
$media->addItem(new TelegramBot\Api\Types\InputMedia\InputMediaPhoto('https://avatars3.githubusercontent.com/u/9335727'));
$media->addItem(new TelegramBot\Api\Types\InputMedia\InputMediaPhoto('https://avatars3.githubusercontent.com/u/9335727'));
// Same for video
// $media->addItem(new TelegramBot\Api\Types\InputMedia\InputMediaVideo('http://clips.vorwaerts-gmbh.de/VfE_html5.mp4'));
$bot->sendMediaGroup($chatId, $media);

客户端

require_once "vendor/autoload.php";

try {
    $bot = new \TelegramBot\Api\Client('YOUR_BOT_API_TOKEN');
    // or initialize with botan.io tracker api key
    // $bot = new \TelegramBot\Api\Client('YOUR_BOT_API_TOKEN', 'YOUR_BOTAN_TRACKER_API_KEY');
    

    $bot->command('ping', function ($message) use ($bot) {
        $bot->sendMessage($message->getChat()->getId(), 'pong!');
    });
    
    $bot->run();

} catch (\TelegramBot\Api\Exception $e) {
    $e->getMessage();
}

Botan SDK(不再支持)

Botan 是一个基于 Yandex.Appmetrica 的 Telegram 机器人分析系统。在此文档中,您可以找到如何设置 Yandex.Appmetrica 账户以及 Botan SDK 的使用示例。

创建账户

  • http://appmetrica.yandex.com/ 注册
  • 注册后,您将被提示创建应用程序。请使用 @YourBotName 作为名称。
  • 从设置页面保存 API 密钥,您将使用它作为 Botan API 调用的令牌。
  • 下载您语言的库,并按以下说明使用。别忘了插入您的令牌!

由于我们刚刚开始,您可能会发现 AppMetriсa 中的一些现有报告对于 Telegram 机器人来说不起作用,例如地理位置、性别、年龄、库、设备、流量来源和网络部分。我们将在以后完善这些。

SDK 使用

独立

$tracker = new \TelegramBot\Api\Botan('YOUR_BOTAN_TRACKER_API_KEY');

$tracker->track($message, $eventName);

API 包装器

$bot = new \TelegramBot\Api\BotApi('YOUR_BOT_API_TOKEN', 'YOUR_BOTAN_TRACKER_API_KEY');

$bot->track($message, $eventName);

您可以使用方法 getUpdates(),所有传入的消息都将自动跟踪为 Message 事件

客户端

$bot = new \TelegramBot\Api\Client('YOUR_BOT_API_TOKEN', 'YOUR_BOTAN_TRACKER_API_KEY');

所有已注册的命令都将自动跟踪为命令名称

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

测试

$ composer test

贡献

请参阅 CONTRIBUTING 以获取详细信息。

安全

如果您发现任何与安全相关的问题,请通过电子邮件 mail@igusev.ru 而不是使用问题跟踪器。

致谢

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件