Telegram Bot SDK

https://telegram-bot-sdk.com/docs
Admin
Telegram Bot SDK is a PHP library that simplifies the development of Telegram bots, offering...
Tokens:54,396
Snippets:239
Trust Score:7.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/getting-started

Instructions for installing and setting up the Telegram Bot SDK. This typically involves using a package manager like Composer.

```bash
composer require irfaqsyn/telegram-bot-sdk
```

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

### Install Telegram Bot SDK with Composer

Source: https://telegram-bot-sdk.com/docs/getting-started/installation

This command installs the Telegram Bot SDK using Composer, the dependency manager for PHP. Ensure Composer is installed before running this command.

```Bash
composer require irazasyed/telegram-bot-sdk
```

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

### Telegram Bot SDK - GetMe Method Example

Source: https://telegram-bot-sdk.com/docs/guides

This example demonstrates how to use the getMe() API method to test your bot's authentication token. It's a basic but essential function for verifying bot setup.

```PHP
<?php

require 'vendor/autoload.php';

use TelegramBot\Api\BotApi;

$bot = new BotApi('YOUR_BOT_TOKEN');

try {
    $response = $bot->getMe();
    print_r($response);
} catch (TelegramBot\Api\Exception\InvalidAccessTokenException $e) {
    // Handle invalid token error
    echo 'Invalid Bot Token: ' . $e->getMessage();
} catch (TelegramBot\Api\Exception\CurlException $e) {
    // Handle cURL error
    echo 'cURL Error: ' . $e->getMessage();
}

?>
```

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

### PHP Comprehensive Command Example

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

A comprehensive example combining command aliases, simple arguments, and regex arguments in a single Telegram bot command. This demonstrates advanced command handling capabilities.

```PHP
<?php

namespace App\Telegram\Commands;

use Telegram\Bot\Actions;
use Telegram\Bot\Commands\Command;

/**
 * This command can be triggered in two ways:
 * /start and /join due to the alias.
 */
class StartCommand extends Command
{
    protected string $name = 'start';
    protected array $aliases = ['join'];
    protected string $description = 'Start Command to get you started';
    protected string $pattern = '{username}  
    {age: \d+}';

    public function handle()
    {

```

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

### Initialize Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/getting-started

Configure the Telegram Bot SDK with your Bot Token obtained from BotFather to access Telegram Bot API methods. This is a crucial step before making any requests.

```php
$bot = new 
																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																	
```

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

### Publish Telegram Bot SDK Configuration for Laravel

Source: https://telegram-bot-sdk.com/docs/getting-started/installation

This command publishes the configuration file for the Telegram Bot SDK in a Laravel project. This allows for customization of the SDK's settings.

```Bash
php artisan vendor:publish --tag="telegram-config"
```

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

### PHP Basic StartCommand for Telegram Bot

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This PHP code defines a basic 'StartCommand' class that extends the SDK's Command class. It sets the command name to 'start' and provides a description. The 'handle' method sends a welcome message to the user when the command is triggered.

```PHP
<?php

namespace App\Telegram\Commands;

use Telegram\Bot\Commands\Command;

class StartCommand extends Command
{
    protected string $name = 'start';
    protected string $description = 'Start Command to get you started';

    public function handle()
    {
        $this->replyWithMessage([
            'text' => 'Hey, there! Welcome to our bot!',
        ]);
    }
}
```

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

### Initialize Telegram Bot SDK (Standalone)

Source: https://telegram-bot-sdk.com/docs/1.x/getting-started/installation

Initializes the Telegram Bot SDK for PHP in a standalone project. Requires a bot token and uses Composer for installation and autoloading.

```PHP
use Telegram\Bot\Api;

$telegram=new Api('YOUR_BOT_TOKEN');
```

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

### Handle Commands with Webhook (Laravel)

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This example shows how to integrate `commandsHandler()` with a webhook in a Laravel application. It includes setting up the route and bypassing CSRF verification for webhook requests.

```PHP
Route::post('/<token>/webhook', function() {
    $update = Telegram::commandsHandler(true);

    // Commands handler method returns the Update object.
    // So you can further process $update object
    // to however you want.

    return 'ok';
});

```

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

### Telegram Bot SDK - Custom Keyboards Example

Source: https://telegram-bot-sdk.com/docs/guides

This guide explains how to implement custom keyboards in Telegram Bot API. Custom keyboards allow bots to present users with predefined reply options, simplifying interaction. Tapping a button sends the corresponding command to the bot.

```PHP
<?php

require 'vendor/autoload.php';

use TelegramBot\Api\BotApi;
use TelegramBot\Api\Types\ReplyKeyboardMarkup;
use TelegramBot\Api\Types\KeyboardButton;

$bot = new BotApi('YOUR_BOT_TOKEN');

// Create keyboard buttons
$button1 = new KeyboardButton('Option 1');
$button2 = new KeyboardButton('Option 2');
$button3 = new KeyboardButton('Option 3');

// Create the reply keyboard markup
$keyboard = new ReplyKeyboardMarkup([
    [$button1, $button2],
    [$button3]
], false, true);

// Send a message with the custom keyboard
$chatId = 'YOUR_CHAT_ID'; // Replace with the actual chat ID
$text = 'Choose an option:';

try {
    $bot->sendMessage($chatId, $text, null, false, null, $keyboard);
} catch (TelegramBot\Api\Exception\InvalidAccessTokenException $e) {
    echo 'Invalid Bot Token: ' . $e->getMessage();
} catch (TelegramBot\Api\Exception\TelegramResponseException $e) {
    echo 'Telegram API Error: ' . $e->getMessage();
}

?>
```

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

### Install Telegram Bot SDK with Composer

Source: https://telegram-bot-sdk.com/docs/2.x/getting-started/installation

This command installs the Telegram Bot SDK version 2.x using Composer, the dependency manager for PHP. Ensure Composer is installed on your system before running this command.

```bash
composer require irazasyed/telegram-bot-sdk:^2.0
```

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

### Get Updates with Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/2.x/guides/available-methods-examples

Shows how to fetch updates from Telegram, which include incoming messages and other events. This is a fundamental method for receiving information from users.

```PHP
$updates=$telegram->getUpdates();

```

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

### Install Telegram Bot SDK with Composer

Source: https://telegram-bot-sdk.com/docs/next/getting-started/installation

This command installs the Telegram Bot SDK version ^3.10 using Composer, the dependency manager for PHP. Ensure Composer is installed before running this command.

```bash
composer require irazasyed/telegram-bot-sdk:^3.10
```

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

### Get Bot Information with getMe()

Source: https://telegram-bot-sdk.com/docs/next/guides

This example demonstrates how to use the getMe() API method to test your bot's authentication token. It's a basic method to verify bot authorization.

```PHP
<?php

use TelegramBotSDK\TelegramBotSDK;

try {
    $bot = new TelegramBotSDK('YOUR_BOT_TOKEN');
    $response = $bot->getMe();

    if ($response->ok) {
        echo "Bot username: " . $response->result->username;
    } else {
        echo "Error: " . $response->description;
    }
} catch (Exception $e) {
    echo "An error occurred: " . $e->getMessage();
}

```

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

### PHP: Register Multiple Commands (Standalone)

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

Illustrates registering multiple Telegram bot commands at once using an array of command class names in a standalone PHP setup.

```PHP
$telegram->addCommands([
Telegram\Bot\Commands\HelpCommand::class,
Vendor\Project\TestCommand::class,
Vendor\Project\StartCommand::class,
]);
```

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

### Get Updates with Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/guides/available-methods-examples

Shows how to fetch incoming updates for the bot, such as new messages or commands. This is a fundamental method for receiving and processing user interactions.

```PHP
$updates=$telegram->getUpdates();

```

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

### Get Bot Info (Standalone PHP)

Source: https://telegram-bot-sdk.com/docs/next/guides/the-basics

Demonstrates how to use the getMe() method in a standalone PHP environment to retrieve basic information about the bot. Requires the SDK to be installed via Composer and autoloading enabled.

```PHP
require_once __DIR__.'/vendor/autoload.php';

use Telegram\Bot\Api;

$telegram = new Api('YOUR BOT TOKEN');
$response = $telegram->getMe();

```

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

### PHP Telegram Bot SDK Installation

Source: https://telegram-bot-sdk.com/docs/index

This snippet shows how to install the Telegram Bot SDK for PHP using Composer, the standard package manager for PHP. It's a common first step for integrating the SDK into a project.

```bash
composer require irfaqsyn/telegram-bot-sdk
```

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

### PHP Telegram Bot SDK Installation

Source: https://telegram-bot-sdk.com/docs/1.x/guides

Instructions for installing the Telegram Bot SDK for PHP. This typically involves using a package manager like Composer.

```bash
composer require irfaqsnap/telegram-bot-sdk
```

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

### PHP Telegram Bot Command Example

Source: https://telegram-bot-sdk.com/docs/1.x/guides/commands-system

An example of a Telegram bot command written in PHP using the SDK. It demonstrates how to define command name and description, handle incoming messages, reply with text and chat actions, list available commands, and trigger other commands.

```PHP
<?php  
  
namespaceVendor\App\Commands;  
  
useTelegram\Bot\Actions;  
useTelegram\Bot\Commands\Command;  
  
classStartCommandextendsCommand  
{
/**  
     * @var string Command Name  
     */  
protected$name="start";  
  
/**  
     * @var string Command Description  
     */  
protected$description="Start Command to get you started";  
  
/**  
     * @inheritdoc  
     */  
publicfunctionhandle($arguments)  
{
// This will send a message using `sendMessage` method behind the   
// backend to the user/chat id who triggered this command.  
// `replyWith<Message|Photo|Audio|Video|Voice|Document|Sticker|Location|ChatAction>()` all the available methods are dynamically  
// handled when you replace `send<Method>` with `replyWith` and use the same parameters - except chat_id does NOT need to be included in the array.  
$this->replyWithMessage('Hello! Welcome to our bot, Here are our available commands:');  
  
// This will update the chat status to typing...  
$this->replyWithChatAction(Actions::TYPING);  
  
// This will prepare a list of available commands and send the user.  
// First, Get an array of all registered commands  
// They'll be in 'command-name' => 'Command Handler Class' format.  
$commands=$this->getTelegram()->getCommands();  
  
// Build the list  
$response='';  
foreach($commandsas$name=>$command){  
$response.=sprintf('/%s - %s'.PHP_EOL,$name,$command->getDescription());  
}  
  
// Reply with the commands list  
$this->replyWithMessage($response);  
  
// Trigger another command dynamically from within this command  
// When you want to chain multiple commands within one or process the request further.  
// The method supports second parameter arguments which you can optionally pass, By default  
// it'll pass the same arguments that are received for this command originally.  
$this->triggerCommand('subscribe');  
}
}
```

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

### PHP: Get Bot Information using getMe()

Source: https://telegram-bot-sdk.com/docs/2.x/guides

Demonstrates how to use the getMe() API method to test your bot's authentication token. This is a basic example for verifying bot authorization.

```PHP
<?php

require 'vendor/autoload.php';

use TelegramBot\Api\BotApi;

$bot = new BotApi('YOUR_BOT_TOKEN');

try {
    $response = $bot->getMe();
    echo "Bot Username: " . $response->getUsername() . "\n";
    echo "Bot Name: " . $response->getFirstName() . "\n";
} catch (TelegramBot\Api\Exceptions\TelegramException $e) {
    echo "Error: " . $e->getMessage();
}

```

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

### PHP sendMessage Method - Version 1.x

Source: https://telegram-bot-sdk.com/docs/2.x/upgrade-guide

Example of how the `sendMessage` method was called in version 1.x of the Telegram Bot SDK for PHP, using individual parameters.

```PHP
$response=$telegram->sendMessage('CHAT_ID','Hello World');
```

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

### Install Telegram Bot SDK using Composer

Source: https://telegram-bot-sdk.com/docs/1

This snippet shows how to install the Telegram Bot SDK for PHP using Composer, the recommended dependency manager for PHP. It includes commands for downloading the Composer installer and adding the SDK as a project dependency.

```bash
curl -sS https://getcomposer.org/installer | php
```

```bash
php composer.phar require irazasyed/telegram-bot-sdk ^1.0
```

```bash
composer require irazasyed/telegram-bot-sdk ^1.0
```

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

### Get Bot Info (Laravel Service Container)

Source: https://telegram-bot-sdk.com/docs/next/guides/the-basics

Illustrates using the getMe() method via Laravel's service container (dependency injection). This example shows how to inject the Telegram Api instance into a controller.

```PHP
<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Telegram\Bot\Api;

class BotController extends Controller
{
    protected $telegram;

    /**
     * Create a new controller instance.
     *
     * @param  Api  $telegram
     */
    public function __construct(Api $telegram)
    {
        $this->telegram = $telegram;
    }

    /**
     * Show the bot information.
     */
    public function show()
    {
        $response = $this->telegram->getMe();

        return $response;
    }
}

```

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

### Telegram Bot SDK - InlineKeyboardButton Example

Source: https://telegram-bot-sdk.com/docs/guides/keyboards

Provides examples of different InlineKeyboardButton configurations, showcasing how to create buttons that open URLs, trigger callback data, or use login URLs for user authorization.

```json
{
  "text": "Click Me",
  "url": "https://telegram.org"
}
```

```json
{
  "text": "Send Data",
  "callback_data": "user_action_123"
}
```

```json
{
  "text": "Login",
  "login_url": {
    "url": "https://your-login-url.com"
  }
}
```

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

### PHP sendMessage Method - Version 2.x

Source: https://telegram-bot-sdk.com/docs/2.x/upgrade-guide

Example of how the `sendMessage` method should be called in version 2.x of the Telegram Bot SDK for PHP, using an associative array of parameters.

```PHP
$response=$telegram->sendMessage([
'chat_id'=>'CHAT_ID',
'text'=>'Hello World'
]);
```

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

### Initialize Telegram Bot SDK (Laravel Facade)

Source: https://telegram-bot-sdk.com/docs/guides/the-basics

This example demonstrates how to use the Telegram Bot SDK within a Laravel application using its Facade. It assumes the SDK is properly configured for Laravel.

```PHP
use Telegram\Bot\Laravel\Facades\Telegram;

$response = Telegram::getMe();
```

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

### Get User Profile Photos with Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/next/guides/available-methods-examples

Demonstrates how to retrieve a user's profile photos using the SDK. It requires the user ID and returns the total count of photos and the photos themselves.

```PHP
$response=$telegram->getUserProfilePhotos(['user_id'=>'USER_ID']);

$photos_count=$response->getTotalCount();
$photos=$response->getPhotos();

```

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

### Publish Telegram Bot SDK Configuration in Laravel

Source: https://telegram-bot-sdk.com/docs/next/getting-started/installation

This command publishes the configuration file for the Telegram Bot SDK in a Laravel project. This is an optional step for Laravel users to customize SDK settings.

```bash
php artisan vendor:publish --tag="telegram-config"
```

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

### PHP ReplyKeyboardMarkup Example

Source: https://telegram-bot-sdk.com/docs/next/guides/keyboards

Demonstrates the structure of a ReplyKeyboardMarkup object in PHP, including properties like keyboard, resize_keyboard, one_time_keyboard, and selective.

```PHP
<?php

use TelegramBotApiTypesReplyKeyboardMarkup;
use TelegramBotApiTypesKeyboardButton;

// Example of creating a ReplyKeyboardMarkup
$keyboard = new ReplyKeyboardMarkup([
    [new KeyboardButton('Option 1'), new KeyboardButton('Option 2')],
    [new KeyboardButton('Option 3')],
]);

// Setting optional properties
$keyboard->setResizeKeyboard(true);
$keyboard->setOneTimeKeyboard(false);
$keyboard->setSelective(false);

// To send this keyboard, you would typically use:
// $bot->sendMessage($chatId, 'Choose an option:', false, false, false, $keyboard);
?>
```

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

### Get User Profile Photos with Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/2.x/guides/available-methods-examples

Demonstrates how to retrieve a user's profile photos using their user ID. The response includes the total count of photos and the photos themselves, which can be iterated over.

```PHP
$response=$telegram->getUserProfilePhotos(['user_id'=>'USER_ID']);

$photos_count=$response->getTotalCount();
$photos=$response->getPhotos();

```

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

### PHP: Reply with Sticker using Helper Method

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This helper method simplifies sending a sticker as a reply. It automatically includes the chat ID and supports parameters for sticker customization.

```PHP
replyWithSticker(array $params): mixed
```

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

### Configure Telegram Bot SDK for Laravel

Source: https://telegram-bot-sdk.com/docs/1.x/getting-started/installation

Sets the bot token for the Telegram Bot SDK within a Laravel project by modifying the `telegram.php` configuration file.

```PHP
'bot_token'=>'1234:ABCD'
```

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

### PHP: Register Single Command (Standalone)

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

Demonstrates registering a single Telegram bot command using its class name or an instantiated command object in a standalone PHP environment.

```PHP
$telegram->addCommand(Telegram\Bot\Commands\HelpCommand::class);

# OR

$command=newTelegram\Bot\Commands\HelpCommand();
$telegram->addCommand($command);
```

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

### Register Global Commands

Source: https://telegram-bot-sdk.com/docs/getting-started/configuration

Register global commands for all bots in the system by listing their class paths in the 'commands' configuration option. This ensures these commands are always active.

```PHP
[ 
'commands'=>[
App\Telegram\Commands\HelpCommand::class,
App\Telegram\Commands\StartCommand::class,
// ... 
],
// ... 
]
```

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

### Send Chat Action with Telegram Bot SDK (String)

Source: https://telegram-bot-sdk.com/docs/guides/available-methods-examples

Shows how to inform the user that the bot is performing an action, such as uploading a photo. The 'action' parameter specifies the type of action.

```PHP
$telegram->sendChatAction([
  'chat_id'=>'CHAT_ID',
  'action'=>'upload_photo'
]);

```

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

### PHP: Register Multiple Commands (Laravel)

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

Demonstrates registering multiple Telegram bot commands simultaneously within a Laravel application by providing an array of command class names.

```PHP
Telegram::addCommands([
Telegram\Bot\Commands\HelpCommand::class,
Vendor\Project\TestCommand::class,
Vendor\Project\StartCommand::class,
]);
```

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

### Combined Command Grouping

Source: https://telegram-bot-sdk.com/docs/getting-started/configuration

Create comprehensive command groups by combining shared commands, references to other command groups, and direct command class paths within a single group definition.

```PHP
[
'shared_commands'=>[
'greeting'=>App\Telegram\Commands\GreetingCommand::class,
// ... 
],
'command_groups'=>[
'my_commands'=>[
'greeting_and_farewell',
'other_commands',
App\Telegram\Commands\StopCommand::class,
// ... 
],
'greeting_and_farewell'=>[
'greeting',
'farewell',
App\Telegram\Commands\StartCommand::class,
// ... 
],
'other_commands'=>[
App\Telegram\Commands\InfoCommand::class,
// ... 
]
// ... 
]
]
```

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

### PHP - Get Updates

Source: https://telegram-bot-sdk.com/docs/1.x/guides/available-methods-examples

Fetches updates from Telegram. This method can be used to retrieve new messages and other events. The result is an array of update objects.

```PHP
$updates=$telegram->getUpdates();
```

```PHP
$updates=Telegram::getUpdates();
```

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

### Update Composer Dependency to v4.0

Source: https://telegram-bot-sdk.com/docs/next/upgrade-guide

This command updates the Telegram Bot SDK package to version 4.0 using Composer. Ensure you have Composer installed and configured in your project.

```Bash
composer require irazasyed/telegram-bot-sdk:^4.0
```

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

### PHP - Create a Telegram Bot Command

Source: https://telegram-bot-sdk.com/docs/2.x/guides/commands-system

This PHP code defines a 'StartCommand' for a Telegram bot. It sets the command's name to 'start' and provides a description. The `handle` method sends a welcome message, indicates the bot is typing, lists available commands, and triggers another command ('subscribe').

```PHP
<?php  
  
namespace Vendor\App\Commands;  
  
use Telegram\Bot\Actions;  
use Telegram\Bot\Commands\Command;  
  
classStartCommandextendsCommand  
{  
/**  
     * @var string Command Name  
     */  
protected$name="start";  
  
/**  
     * @var string Command Description  
     */  
protected$description="Start Command to get you started";  
  
/**  
     * @inheritdoc  
     */  
publicfunctionhandle($arguments)  
{  
// This will send a message using `sendMessage` method behind the scenes to  
// the user/chat id who triggered this command.  
// `replyWith<Message|Photo|Audio|Video|Voice|Document|Sticker|Location|ChatAction>()` all the available methods are dynamically  
// handled when you replace `send<Method>` with `replyWith` and use the same parameters - except chat_id does NOT need to be included in the array.  
$this->replyWithMessage(['text'=>'Hello! Welcome to our bot, Here are our available commands:']);  
  
// This will update the chat status to typing...  
$this->replyWithChatAction(['action'=>Actions::TYPING]);  
  
// This will prepare a list of available commands and send the user.  
// First, Get an array of all registered commands  
// They'll be in 'command-name' => 'Command Handler Class' format.  
$commands=$this->getTelegram()->getCommands();  
  
// Build the list  
$response='';  
foreach($commandsas$name=>$command){  
$response.=sprintf('/%s - %s'.PHP_EOL,$name,$command->getDescription());  
}  
  
// Reply with the commands list  
$this->replyWithMessage(['text'=>$response]);  
  
// Trigger another command dynamically from within this command  
// When you want to chain multiple commands within one or process the request further.  
// The method supports second parameter arguments which you can optionally pass, By default  
// it'll pass the same arguments that are received for this command originally.  
$this->triggerCommand('subscribe');  
}  
}  

```

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

### Initialize SDK with Configuration Options

Source: https://telegram-bot-sdk.com/docs/getting-started/configuration

This snippet demonstrates how to initialize the Telegram Bot SDK with various configuration options, including managing multiple bots, enabling asynchronous requests, and specifying custom HTTP clients.

```PHP
<?php

use Telegram\Bot\Api;
use Telegram\Bot\BotsManager;
use Telegram\Bot\HttpClients\GuzzleHttpClient;

// Configuration for multiple bots
$bots = [
    'default' => [
        'username' => 'my_telegram_bot',
        'token' => 'YOUR_TELEGRAM_BOT_TOKEN',
    ],
    'second_bot' => [
        'username' => 'another_telegram_bot',
        'token' => 'ANOTHER_TELEGRAM_BOT_TOKEN',
    ],
];

// Initialize BotsManager
$botsManager = new BotsManager($bots);

// Optionally set a default bot
$botsManager->setDefaultBot('default');

// Initialize SDK with BotsManager and custom options
$config = [
    'bots' => $bots,
    'default' => 'default', // Specify the default bot
    'async_requests' => true, // Enable asynchronous requests
    'http_client_handler' => GuzzleHttpClient::class, // Use Guzzle HTTP client
    'base_bot_url' => 'https://api.telegram.org/bot',
    'resolve_command_dependencies' => true, // Resolve command dependencies
    'commands' => [
        // Register global commands here
        'Telegram\Bot\Commands\HelpCommand'
    ],
    'command_groups' => [
        'default' => [
            'Telegram\Bot\Commands\HelpCommand',
            'Telegram\Bot\Commands\StartCommand'
        ]
    ],
    'shared_commands' => [
        'help' => 'Telegram\Bot\Commands\HelpCommand'
    ]
];

$bot = new Api('YOUR_TELEGRAM_BOT_TOKEN', false, $botsManager);

// Or using the configuration array directly
$bot = new Api('YOUR_TELEGRAM_BOT_TOKEN', false, null, $config);

// Now you can use the $bot object to interact with the Telegram API

?>
```

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

### Handle Commands with Long-Polling (Laravel)

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This example demonstrates using `commandsHandler()` with long-polling in a Laravel application. It processes updates by manually fetching them using `getUpdates()` with a specified timeout.

```PHP
$update = Telegram::commandsHandler(false, ['timeout' => 30]);
```

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

### PHP - Create a Telegram Bot Command

Source: https://telegram-bot-sdk.com/docs/next/guides/commands-system

This PHP code defines a 'StartCommand' for a Telegram bot. It sets the command's name to 'start' and provides a description. The `handle` method sends a welcome message, indicates the bot is typing, lists available commands, and triggers another command ('subscribe').

```PHP
<?php  
  
namespace Vendor\App\Commands;  
  
use Telegram\Bot\Actions;  
use Telegram\Bot\Commands\Command;  
  
classStartCommandextendsCommand  
{  
/**  
     * @var string Command Name  
     */  
protected$name="start";  
  
/**  
     * @var string Command Description  
     */  
protected$description="Start Command to get you started";  
  
/**  
     * @inheritdoc  
     */  
publicfunctionhandle($arguments)  
{  
// This will send a message using `sendMessage` method behind the scenes to  
// the user/chat id who triggered this command.  
// `replyWith<Message|Photo|Audio|Video|Voice|Document|Sticker|Location|ChatAction>()` all the available methods are dynamically  
// handled when you replace `send<Method>` with `replyWith` and use the same parameters - except chat_id does NOT need to be included in the array.  
$this->replyWithMessage(['text'=>'Hello! Welcome to our bot, Here are our available commands:']);  
  
// This will update the chat status to typing...  
$this->replyWithChatAction(['action'=>Actions::TYPING]);  
  
// This will prepare a list of available commands and send the user.  
// First, Get an array of all registered commands  
// They'll be in 'command-name' => 'Command Handler Class' format.  
$commands=$this->getTelegram()->getCommands();  
  
// Build the list  
$response='';  
foreach($commandsas$name=>$command){  
$response.=sprintf('/%s - %s'.PHP_EOL,$name,$command->getDescription());  
}  
  
// Reply with the commands list  
$this->replyWithMessage(['text'=>$response]);  
  
// Trigger another command dynamically from within this command  
// When you want to chain multiple commands within one or process the request further.  
// The method supports second parameter arguments which you can optionally pass, By default  
// it'll pass the same arguments that are received for this command originally.  
$this->triggerCommand('subscribe');  
}  
}  

```

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

### Update Composer Dependency

Source: https://telegram-bot-sdk.com/docs/1.x/upgrade-guide

This command updates the Telegram Bot SDK package to version 1.0 using Composer. Ensure you have Composer installed and configured in your project.

```bash
composer require irazasyed/telegram-bot-sdk ^1.0
```

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

### Test Bot Authentication Token (Standalone)

Source: https://telegram-bot-sdk.com/docs/1.x/getting-started/installation

Tests the bot's authentication token using the `getMe` method in a standalone PHP project. Retrieves basic bot information like ID, first name, and username.

```PHP
$response=$telegram->getMe();

$botId=$response->getId();
$firstName=$response->getFirstName();
$username=$response->getUsername();
```

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

### Publish Telegram Bot SDK Configuration File

Source: https://telegram-bot-sdk.com/docs/2.x/getting-started/installation

This Artisan command publishes the Telegram Bot SDK's configuration file to your Laravel project. This allows you to customize the SDK's settings. Run this command in your terminal.

```bash
php artisan vendor:publish --provider="Telegram\Bot\Laravel\TelegramServiceProvider"
```

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

### Get Updates with Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/next/guides/available-methods-examples

Shows how to fetch updates from Telegram using the SDK. This method retrieves new messages and other events that have occurred in the chats associated with the bot.

```PHP
$updates=$telegram->getUpdates();

```

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

### PHP - Get User Profile Photos

Source: https://telegram-bot-sdk.com/docs/1.x/guides/available-methods-examples

Retrieves a list of user profile photos. It requires the user ID and returns the total count of photos and the photos themselves in the response object.

```PHP
$response=$telegram->getUserProfilePhotos('USER_ID');

$photos_count=$response->getTotalCount();
$photos=$response->getPhotos();
```

```PHP
$response=Telegram::getUserProfilePhotos('USER_ID');

$photos_count=$response->getTotalCount();
$photos=$response->getPhotos();
```

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

### Initialize Telegram Bot SDK (Standalone)

Source: https://telegram-bot-sdk.com/docs/guides/the-basics

This snippet shows how to initialize the Telegram Bot SDK in a standalone PHP environment and make a getMe() API call. It requires the SDK to be installed via Composer and includes the autoloader.

```PHP
require_once __DIR__.'/vendor/autoload.php';

use Telegram\Bot\Api;

$telegram = new Api('YOUR BOT TOKEN');
$response = $telegram->getMe();
```

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

### Handle Commands with Long-Polling (Standalone)

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This snippet illustrates using the `commandsHandler()` method with long-polling updates in a standalone PHP setup. It processes updates by manually fetching them using `getUpdates()`.

```PHP
$update = $telegram->commandsHandler(false, ['timeout' => 30]);
```

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

### Test Bot Authentication Token (Laravel)

Source: https://telegram-bot-sdk.com/docs/1.x/getting-started/installation

Tests the bot's authentication token using the `getMe` method within a Laravel project. Retrieves basic bot information like ID, first name, and username.

```PHP
$response=Telegram::getMe();

$botId=$response->getId();
$firstName=$response->getFirstName();
$username=$response->getUsername();
```

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

### Get User Profile Photos with Telegram Bot SDK

Source: https://telegram-bot-sdk.com/docs/guides/available-methods-examples

Demonstrates how to retrieve a list of profile photos for a specific Telegram user. It requires the user ID and returns the total count of photos and the photos themselves.

```PHP
$response=$telegram->getUserProfilePhotos(['user_id'=>'USER_ID']);

$photos_count=$response->getTotalCount();
$photos=$response->getPhotos();

```

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

### PHP: Reply with Video using Helper Method

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This helper method allows for sending a video as a reply to the user. It comes with the chat ID pre-populated and accepts an array of parameters for video customization.

```PHP
replyWithVideo(array $params): mixed
```

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

### PHP: Get Username and Reply

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This snippet demonstrates how to retrieve a username from a Telegram update object or a command argument, with a fallback mechanism. It then uses the username to send a personalized greeting and lists available bot commands.

```PHP
$fallbackUsername=$this->getUpdate()->getMessage()->from->username;
$username=$this->argument(
'username',
$fallbackUsername
);
$this->replyWithMessage([
'text'=>'Hello {$username}! Welcome to our bot, Here are our available commands:'
]);
$this->replyWithChatAction(['action'=>Actions::TYPING]);
$commands=$this->getTelegram()->getCommands();
$response='';
foreach($commandsas$name=>$command){
$response.=sprintf('/%s - %s'.PHP_EOL,$name,$command->getDescription());
}
$this->replyWithMessage(['text'=>$response]);
if($this->argument('age',0)>=18){
$this->replyWithMessage(['text'=>'Congrats, You are eligible to buy premimum access to our membership!']);
}else{
$this->replyWithMessage(['text'=>'Sorry, you are not eligible to access premium membership yet!']);
}
}
```

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

### Initialize Telegram Bot SDK (Standalone)

Source: https://telegram-bot-sdk.com/docs/getting-started/initialize

This snippet shows how to initialize the Telegram Bot SDK in a standalone PHP application. It requires the autoloader, uses the Api class, and initializes it with your bot token. An example of making a 'getMe' request is included.

```PHP
require __DIR__.'/vendor/autoload.php';

use Telegram\Bot\Api;

$telegram = new Api('YOUR BOT TOKEN');

// Example usage
$response = $telegram->getMe();
```

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

### Send Chat Action with Telegram Bot SDK (Constant)

Source: https://telegram-bot-sdk.com/docs/guides/available-methods-examples

Provides an alternative way to send a chat action using predefined constants from the SDK's Actions class, improving code readability and maintainability.

```PHP
use Telegram\Bot\Actions;

$telegram->sendChatAction([
  'chat_id'=>'CHAT_ID',
  'action'=>Actions::RECORD_VIDEO
]);

```

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

### Get Bot Info (PHP Standalone)

Source: https://telegram-bot-sdk.com/docs/2.x/guides/the-basics

Demonstrates how to use the 'getMe()' API method with the Telegram Bot SDK in a standalone PHP environment. This requires including the autoloader and initializing the API with your bot token.

```PHP
require __DIR__.'/vendor/autoload.php';

use Telegram\Bot\Api;

$telegram = new Api('YOUR BOT TOKEN');
$response = $telegram->getMe();
```

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

### PHP InlineKeyboardMarkup Example

Source: https://telegram-bot-sdk.com/docs/next/guides/keyboards

Shows the structure for creating an InlineKeyboardMarkup in PHP, which includes an array of button rows.

```PHP
<?php

use TelegramBotApiTypesInlineInlineKeyboardMarkup;
use TelegramBotApiTypesInlineInlineKeyboardButton;

// Example of creating an InlineKeyboardMarkup
$inlineKeyboard = new InlineKeyboardMarkup([
    [
        InlineKeyboardButton::create('Button 1', ['callback_data' => 'action1']),
        InlineKeyboardButton::create('Button 2', ['url' => 'https://example.com'])
    ],
    [
        InlineKeyboardButton::create('Button 3', ['callback_data' => 'action3'])
    ]
]);

// To send this keyboard with a message:
// $bot->sendMessage($chatId, 'Choose an action:', false, false, false, $inlineKeyboard);
?>
```

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

### PHP ReplyKeyboardRemove Example

Source: https://telegram-bot-sdk.com/docs/next/guides/keyboards

Illustrates how to create a ReplyKeyboardRemove object in PHP to remove the custom keyboard from the chat.

```PHP
<?php

use TelegramBotApiTypesReplyKeyboardRemove;

// Example of creating a ReplyKeyboardRemove object
$removeKeyboard = new ReplyKeyboardRemove();

// Setting optional properties
$removeKeyboard->setSelective(false);

// To send this to remove the keyboard:
// $bot->sendMessage($chatId, 'Keyboard removed.', false, false, false, $removeKeyboard);
?>
```

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

### Manage Multiple Telegram Bots (Standalone)

Source: https://telegram-bot-sdk.com/docs/getting-started/initialize

This code demonstrates how to manage multiple Telegram bots using the BotsManager class. It defines a configuration array with bot tokens and shows how to select and interact with a specific bot using its alias.

```PHP
use Telegram\Bot\BotsManager;

$config = [
    'bots' => [
        'mybot' => [
            'token' => '123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11',
        ],
    ]
];

$telegram = new BotsManager($config);

// Example usage
$response = $telegram->bot('mybot')->getMe();
```

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

### Get Webhook Update (PHP)

Source: https://telegram-bot-sdk.com/docs/next/guides/webhook-updates

Retrieves updates sent to the webhook URL. Returns an array of Update objects.

```PHP
$updates=$telegram->getWebhookUpdate();
```

```PHP
// Put this inside the POST route /<token>/webhook or POST Controller
$updates=Telegram::getWebhookUpdate();

// Example of POST Route:  
Route::post('/<token>/webhook',function(){
$updates=Telegram::getWebhookUpdate();

return'ok';
});
```

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

### Handling Telegram Bot SDK Responses

Source: https://telegram-bot-sdk.com/docs/guides/the-basics

This example shows how to access data from the User object returned by the getMe() method using getter methods provided by the SDK. The SDK maps response data to PHP objects.

```PHP
$botId = $response->getId();
$firstName = $response->getFirstName();
$username = $response->getUsername();
```

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

### PHP: Remove Multiple Commands

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

Illustrates how to unregister multiple Telegram bot commands at once by providing an array of command names.

```PHP
$this->removeCommands(array $commands);
```

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

### PHP: Reply with Audio using Helper Method

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

This helper method simplifies sending an audio message as a reply. It automatically includes the chat ID and supports various parameters for audio message configuration.

```PHP
replyWithAudio(array $params): mixed
```

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

### PHP: Remove Single Command

Source: https://telegram-bot-sdk.com/docs/guides/commands-system

Shows how to remove a specific registered Telegram bot command on-the-fly using its command name.

```PHP
$this->removeCommand('command_name');
```
Tokens:
Raw