A Telegram Bot based on the official
Telegram Bot API
Table of Contents
IntroductionThis is a pure PHP Telegram Bot, fully extensible via plugins. Telegram announced official support for a Bot API, allowing integrators of all sorts to bring automated interactions to the mobile platform. This Bot aims to provide a platform where one can simply write a bot and have interactions in a matter of minutes. The Bot can:
This code is available on GitHub. Pull requests are welcome. InstructionsCreate your first bot
Optionally set the bot privacy:
Require this package with ComposerInstall this package through
Composer. Edit your project's Create composer.json file { "name": "yourproject/yourproject", "type": "project", "require": { "php": ">=7.3", "longman/telegram-bot": "*" } } and
run or run this command in your command line: composer require longman/telegram-bot Choose how to retrieve Telegram updatesThe bot can handle updates with Webhook or getUpdates method:
Using a custom Bot API serverFor advanced users only! As from Telegram Bot API 5.0, users can run their own Bot API server to handle updates. This means, that the PHP Telegram Bot needs to be configured to serve that custom URI. Additionally, you can define
the URI where uploaded files to the bot can be downloaded (note the Longman\TelegramBot\Request::setCustomBotApiUri( $api_base_uri = 'https://your-bot-api-server', // Default: https://api.telegram.org $api_base_download_uri = '/path/to/files/{API_KEY}' // Default: /file/bot{API_KEY} ); Note: If you are running your bot in Webhook installationNote: For a more detailed explanation, head over to the example-bot repository and follow the instructions there. In order to set a Webhook you need a server with HTTPS and composer support. (For a self signed certificate you need to add some extra code) Create set.php with the following contents: <?php // Load composer require __DIR__ . '/vendor/autoload.php'; $bot_api_key = 'your:bot_api_key'; $bot_username = 'username_bot'; $hook_url = 'https://your-domain/path/to/hook.php'; try { // Create Telegram API object $telegram = new Longman\TelegramBot\Telegram($bot_api_key, $bot_username); // Set webhook $result = $telegram->setWebhook($hook_url); if ($result->isOk()) { echo $result->getDescription(); } } catch (Longman\TelegramBot\Exception\TelegramException $e) { // log telegram errors // echo $e->getMessage(); } Open your set.php via the browser to register the webhook with Telegram. You should see Now, create hook.php with the following contents: <?php // Load composer require __DIR__ . '/vendor/autoload.php'; $bot_api_key = 'your:bot_api_key'; $bot_username = 'username_bot'; try { // Create Telegram API object $telegram = new Longman\TelegramBot\Telegram($bot_api_key, $bot_username); // Handle telegram webhook request $telegram->handle(); } catch (Longman\TelegramBot\Exception\TelegramException $e) { // Silence is golden! // log telegram errors // echo $e->getMessage(); } Self Signed CertificateUpload the certificate and add the path as a parameter in set.php: $result = $telegram->setWebhook($hook_url, ['certificate' => '/path/to/certificate']); Unset WebhookEdit unset.php with your bot credentials and execute it. getUpdates installationFor best performance, the MySQL database should be enabled for the Create getUpdatesCLI.php with the following contents: #!/usr/bin/env php <?php require __DIR__ . '/vendor/autoload.php'; $bot_api_key = 'your:bot_api_key'; $bot_username = 'username_bot'; $mysql_credentials = [ 'host' => 'localhost', 'port' => 3306, // optional 'user' => 'dbuser', 'password' => 'dbpass', 'database' => 'dbname', ]; try { // Create Telegram API object $telegram = new Longman\TelegramBot\Telegram($bot_api_key, $bot_username); // Enable MySQL $telegram->enableMySql($mysql_credentials); // Handle telegram getUpdates request $telegram->handleGetUpdates(); } catch (Longman\TelegramBot\Exception\TelegramException $e) { // log telegram errors // echo $e->getMessage(); } Next, give the file permission to execute: $ chmod +x getUpdatesCLI.php Lastly, run it! getUpdates without databaseIf you choose to / or are obliged to use the $telegram->useGetUpdatesWithoutDatabase(); Filter Update❗ Note that by default, Telegram will send any new update types that may be added in the future. This may cause commands that don't take this into account to break! It is suggested that you specifically define which update types your bot can receive and handle correctly. You can define which update types are sent to your bot by defining them when setting the webhook or passing an array of allowed types when using getUpdates. use Longman\TelegramBot\Entities\Update; // For all update types currently implemented in this library: // $allowed_updates = Update::getUpdateTypes(); // Define the list of allowed Update types manually: $allowed_updates = [ Update::TYPE_MESSAGE, Update::TYPE_CHANNEL_POST, // etc. ]; // When setting the webhook. $telegram->setWebhook($hook_url, ['allowed_updates' => $allowed_updates]); // When handling the getUpdates method. $telegram->handleGetUpdates(['allowed_updates' => $allowed_updates]); Alternatively, Update processing can be allowed or denied by defining a custom update filter. Let's say we only want to allow messages from a
user with ID $telegram->setUpdateFilter(function (Update $update, Telegram $telegram, &$reason = 'Update denied by update_filter') { $user_id = $update->getMessage()->getFrom()->getId(); if ($user_id === 428) { return true; } $reason = "Invalid user with ID {$user_id}"; return false; }); The reason for denying an update can be defined with
the SupportTypesAll types are implemented according to Telegram API 6.2 (August 2022). Inline QueryFull support for inline query according to Telegram API 6.2 (August 2022). MethodsAll methods are implemented according to Telegram API 6.2 (August 2022). Send MessageMessages longer than 4096 characters are split up into multiple messages. $result = Request::sendMessage([ 'chat_id' => $chat_id, 'text' => 'Your utf8 text 😜 ...', ]); Send PhotoTo send a local photo, add it properly to the $result = Request::sendPhoto([ 'chat_id' => $chat_id, 'photo' => Request::encodeFile('/path/to/pic.jpg'), ]); If you know the $result = Request::sendPhoto([ 'chat_id' => $chat_id, 'photo' => 'AAQCCBNtIhAoAAss4tLEZ3x6HzqVAAqC', ]); To send a remote photo, use the direct URL instead: $result = Request::sendPhoto([ 'chat_id' => $chat_id, 'photo' => 'https://example.com/path/to/pic.jpg', ]); sendAudio, sendDocument, sendAnimation, sendSticker, sendVideo, sendVoice and sendVideoNote all work in the same way, just check the API documentation for the exact usage. See the ImageCommand.php for a full example. Send Chat ActionRequest::sendChatAction([ 'chat_id' => $chat_id, 'action' => Longman\TelegramBot\ChatAction::TYPING, ]); getUserProfilePhotoRetrieve the user photo. (see WhoamiCommand.php for a full example) getFile and downloadFileGet the file path and download it. (see WhoamiCommand.php for a full example) Send message to all active chatsTo do this you have to enable the MySQL connection. Here's an example of use (check $results = Request::sendToActiveChats( 'sendMessage', // Callback function to execute (see Request.php methods) ['text' => 'Hey! Check out the new features!!'], // Param to evaluate the request [ 'groups' => true, 'supergroups' => true, 'channels' => false, 'users' => true, ] ); You can also broadcast a message to users, from the private chat with your bot. Take a look at the admin commands below. UtilsMySQL storage (Recommended)If you want to save
messages/users/chats for further usage in commands, create a new database ( $mysql_credentials = [ 'host' => 'localhost', 'port' => 3306, // optional 'user' => 'dbuser', 'password' => 'dbpass', 'database' => 'dbname', ]; $telegram->enableMySql($mysql_credentials); You can set a custom prefix to all the tables while you are enabling MySQL: $telegram->enableMySql($mysql_credentials, $bot_username . '_'); You can also store inline query and chosen inline query data in the database. External Database connectionIt is possible to provide the library with an external MySQL PDO connection. Here's how to configure it: $telegram->enableExternalMySql($external_pdo_connection); //$telegram->enableExternalMySql($external_pdo_connection, $table_prefix) Channels SupportAll methods implemented can be used to manage channels. With admin commands you can manage your channels directly with your bot private chat. CommandsPredefined CommandsThe bot is able to recognise commands in a chat with multiple bots (/command@mybot). It can also execute commands that get triggered by events, so-called Service Messages. Custom CommandsMaybe you would like to develop your own commands. There is a guide to help you create your own commands. Also, be sure to have a look at the example commands to learn more about custom commands and how they work. You can add your custom commands in different ways: // Add a folder that contains command files $telegram->addCommandsPath('/path/to/command/files'); //$telegram->addCommandsPaths(['/path/to/command/files', '/another/path']); // Add a command directly using the class name $telegram->addCommandClass(MyCommand::class); //$telegram->addCommandClasses([MyCommand::class, MyOtherCommand::class]); Commands ConfigurationWith this method you can set some command specific parameters, for example: // Google geocode/timezone API key for /date command $telegram->setCommandConfig('date', [ 'google_api_key' => 'your_google_api_key_here', ]); // OpenWeatherMap API key for /weather command $telegram->setCommandConfig('weather', [ 'owm_api_key' => 'your_owm_api_key_here', ]); Admin CommandsEnabling this feature, the bot admin can perform some super user commands like:
Take a look at all default admin commands stored in the src/Commands/AdminCommands/ folder. Set AdminsYou can specify one or more admins with this option:
// Single admin $telegram->enableAdmin(your_telegram_user_id); // Multiple admins $telegram->enableAdmins([ your_telegram_user_id, other_telegram_user_id, ]); Telegram user id can be retrieved with the /whoami command. Channel AdministrationTo enable this feature follow these steps:
$telegram->setCommandConfig('sendtochannel', [ 'your_channel' => [ '@type_here_your_channel', ] ]);
$telegram->setCommandConfig('sendtochannel', [ 'your_channel' => [ '@type_here_your_channel', '@type_here_another_channel', '@and_so_on', ] ]);
Upload and Download directory pathTo use the Upload and Download functionality, you need to set the paths with: $telegram->setDownloadPath('/your/path/Download'); $telegram->setUploadPath('/your/path/Upload'); DocumentationTake a look at the repo Wiki for further information and tutorials! Feel free to improve! AssetsAll project assets can be found in the assets repository. Example botWe're busy working on a full A-Z example bot, to help get you started with this library and to show you how to use all its features. You can check the progress of the example-bot repository). Projects with this libraryHere's a list of projects that feats this library, feel free to add yours!
TroubleshootingIf you like living on the edge, please report any bugs you find on the PHP Telegram Bot issues page. ContributingSee CONTRIBUTING for more information. SecuritySee SECURITY for more information. DonateAll work on this bot consists of many hours of coding during our free time, to provide you with a Telegram Bot library that is easy to use and extend. If you enjoy using this library and would like to say thank you, donations are a great way to show your support. Donations are invested back into the project 👍 Thank you for keeping this project alive 🙏 For enterpriseAvailable as part of the Tidelift Subscription. The maintainers of LicensePlease see the LICENSE included in this repository for a full copy of the MIT license, which this project is licensed under. CreditsCredit list in CREDITS |