romanggit/telegram-bot-api

Telegram Bot API的PHP包装器

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账户,用于自动处理消息。用户可以通过向机器人发送命令消息(在私聊或群聊中)与机器人交互。

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

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

安装

通过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)。请参阅许可文件以获取更多信息。