Telegraph

https://github.com/defstudio/telegraph
Admin
Telegraph is a Laravel package for fluently building and managing Telegram bots with support for...
Tokens:51,757
Snippets:737
Trust Score:9.5
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Handle the /start command

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

The '/start' command is a common command handled by a 'start()' method in the webhook handler. This example shows how to send an HTML message in response.

```php
namespace App\Http\Webhooks;

use DefStudio\Telegraph\Handlers\WebhookHandler;

class MyWebhookHandler extends WebhookHandler
{
    public function start(): void
    {
        $this->chat->html('Welcome!')->send();
    }
}
```

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

### Install Telegraph Package

Source: https://github.com/defstudio/telegraph/blob/main/README.md

Install the Telegraph package using Composer.

```bash
composer require defstudio/telegraph
```

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

### Telegraph Configuration Example

Source: https://github.com/defstudio/telegraph/blob/main/docs/2.installation.md

An example of the Telegraph configuration file, showing available options for API URL, parse mode, webhooks, timeouts, security, models, and storage.

```php
return [
    /*
     * Telegram api base url, it can be overridden
     * for self-hosted servers
     */
    'telegram_api_url' => 'https://api.telegram.org/',

    /*
     * Sets Telegraph messages default parse mode
     * allowed values: html|markdown|MarkdownV2
     */
    'default_parse_mode' => Telegraph::PARSE_HTML,

    'webhook' => [
        /*
         * Sets the webhook URL that will be exposed by the server,
         * this can be customized or entirely disabled (by setting it to NULL)
         */
        'url' => '/telegraph/{token}/webhook',

        /*
         * Sets the handler to be used when Telegraph
         * receives a new webhook call.
         *
         * For reference, see https://docs.defstudio.it/telegraph/v1/webhooks/overview
         */
        'handler' => DefStudio	elegraph	elegraph	elegraph	Handlers	EmptyWebhookHandler::class,

        /*
         * Middleware to be applied to the webhook route
         */
        'middleware' => [],

        /*
         * Sets a custom domain when registering a webhook. This will allow a local telegram bot api server
         * to reach the webhook.
         *
         * For reference, see https://core.telegram.org/bots/api#using-a-local-bot-api-server
         */
        // 'domain' => 'http://my.custom.domain',

        /*
         * If enabled, unknown webhook commands are
         * reported as exception in application logs
         */
        'report_unknown_commands' => true,

        /*
         * If enabled, Telegraph dumps received
         * webhook messages to logs
         */
        'debug' => false,
    ],
    
    /*
     * Sets HTTP request timeout when interacting with Telegram servers
     */
    'http_timeout' => 30,
    
     /*
     * Sets HTTP connection request timeout when interacting with Telegram servers
     */
    'http_connection_timeout' => 10,

    'security' => [
        /*
         * if enabled, allows callback queries from unregistered chats
         */
        'allow_callback_queries_from_unknown_chats' => false,

        /*
         * if enabled, allows messages and commands from unregistered chats
         */
        'allow_messages_from_unknown_chats' => false,

        /*
         * if enabled, store unknown chats as new TelegraphChat models
         */
        'store_unknown_chats_in_db' => false,
    ],

    /*
     * Set model class for both TelegraphBot and TelegraphChat,
     * to allow more customization.
     *
     * Bot model must be or extend `DefStudio	elegraph	Models	TelegraphBot::class`
     * Chat model must be or extend `DefStudio	elegraph	Models	TelegraphChat::class`
     */
    'models' => [
        'bot' => DefStudio	elegraph	Models	TelegraphBot::class,
        'chat' => DefStudio	elegraph	Models	TelegraphChat::class,
    ],

    'storage' => [
        /**
         * Default storage driver to be used for Telegraph data
         */
        'default' => 'file',

        'stores' => [
            'file' => [
                /**
                 * Telegraph cache driver to be used, must implement
                 * DefStudio	elegraph	Contracts	StorageDriver contract
                 */
                'driver' => 	DefStudio	elegraph	Storage	FileStorageDriver::class,

                /*
                 * Laravel Storage disk to use. See /config/filesystems/disks for available disks
                 * If 'null', Laravel default store will be used,
                 */
                'disk' => 'local',

                /**
                 * Folder inside filesystem to be used as root for Telegraph storage
                 */
                'root' => 'telegraph',
            ],
            'cache' => [
                /**
                 * Telegraph cache driver to be used, must implement
                 * DefStudio	elegraph	Contracts	StorageDriver contract
                 */
                'driver' => 	DefStudio	elegraph	Storage	CacheStorageDriver::class,

                /*
                 * Laravel Cache store to use. See /config/cache/stores for available stores
                 * If 'null', Laravel default store will be used,
                 */
                'store' => null,

                /*
                 * Prefix to be prepended to cache keys
                 */
                'key_prefix' => 'tgph',
            ],
        ],
    ],
];
```

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

### Define a Web App Button

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/3.keyboards.md

Starts a Telegram bot Web App using the provided URL.

```php
Button::make('open')->webApp('https://webapp.url.dev'),
```

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

### Start Laravel Development Server

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/3.setting-webhook.md

Starts the local development server for your Laravel application. This is typically run on port 8000.

```shell
php artisan serve
```

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

### Register New Bot via Artisan Command

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/2.register-new-bot.md

Use this command to initiate a guided wizard for creating a new bot, which can optionally set up a chat and webhook.

```shell
php artisan telegraph:new-bot
```

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

### Retrieve Callback Data using ->get()

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/5.callback-data.md

Use the ->get() method on the callback data object to retrieve specific keys. You can also provide a default value if the key is not found.

```php
class CustomWebhookHandler extends WebhookHandler
{
    public function dismiss()
    {
        //...

        $key1 = $this->data->get('key1'); //foo

        $key3 = $this->data->get('key1', 'default value'); //default value
    }
}
```

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

### Define a Login URL Button

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/3.keyboards.md

Starts a Telegram login widget using the provided URL.

```php
Button::make('open')->loginUrl('https://login.url.dev'),
```

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

### Retrieve files URL

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Get the configured files URL for the chat.

```php
/** @var \DefStudio\Telegraph\Models\TelegraphChat $telegraphChat */

$telegraphChat->getFilesUrl();
```

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

### Send a Message with Custom Keyboard

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/2.telegraph-facade.md

This example demonstrates sending a message with a custom inline keyboard. The keyboard can include various button types like actions, URLs, and copy text.

```php
Telegraph::message('hello world')
    ->keyboard(Keyboard::make()->buttons([
        Button::make("🗑️ Delete")->action("delete")->param('id', $notification->id),  
        Button::make("📖 Mark as Read")->action("read")->param('id', $notification->id),  
        Button::make("👀 Open")->url('https://test.it'),  
        Button::make("📋 Copy to Clipboard")->copyText('https://example.com/share/123'),  
    ])->chunk(2))->send();
```

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

### Handling Callback Query Payload

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Process a simple callback query payload with 'action' and 'notification-id' parameters. This example shows how to extract these values and perform an action.

```text
action:dismiss;notification-id:42
```

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

### Get Registered Commands

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/1.bots.md

Retrieves the list of commands currently registered for the bot.

```php
$response = Telegraph::getRegisteredCommands()->send();
$response->json('result');
```

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

### Handle Member Joined Chat

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Override this method to send a welcome message when a new member joins a chat. It uses the User DTO to get the member's first name.

```php
class CustomWebhookHandler extends WebhookHandler
{
    protected function handleChatMemberJoined(User $member): void
    {
        $this->chat->html("Welcome {$member->firstName()}")->send();
    }
}
```

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

### Answer Inline Query with Photos

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Use `answerInlineQuery()` to send back results for an inline query. This example demonstrates sending photo results with captions.

```php
$telegraphBot->answerInlineQuery($inlineQuery->id(), [
    InlineQueryResultPhoto::make($logo->id."-"."light", "https://logofinder.dev/$logo->id/light.jpg", "https://logofinder.dev/$logo->id/light/thumb.jpg")
        ->caption('Light Logo'),
    InlineQueryResultPhoto::make($logo->id."-"."dark", "https://logofinder.dev/$logo->id/dark.jpg", "https://logofinder.dev/$logo->id/dark/thumb.jpg")
        ->caption('Light Logo'),
])->cache(seconds: 600)->send();
```

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

### Allow Messages from Unknown Chats

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/6.build-your-first-bot.md

Temporarily enable message acceptance from unknown chats in `config/telegraph.php` for initial setup or onboarding.

```php
'security' => [
    // ...
    'allow_messages_from_unknown_chats' => true,
],
```

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

### Get Bot Information

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/1.bots.md

Retrieves data about the bot. The response includes bot ID, name, and capabilities.

```php
Telegraph::botInfo()->send();

/*
id: xxxxx
is_bot: true
first_name: telegraph-test
username: my_test_bot
can_join_groups: true
can_read_all_group_messages: false
supports_inline_queries: false
*/
```

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

### replaceKeyboard

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/7.keyboard-interaction.md

The entire keyboard can be replaced using the `->replaceKeyboard()` method. This method allows you to update the keyboard displayed to the user, for example, by removing a button after it has been used.

```APIDOC
## replaceKeyboard

### Description
Replaces the entire current keyboard with a new one.

### Method
This is a method of the `WebhookHandler` class, likely invoked within a handler method.

### Usage Example
```php
class CustomWebhookHandler extends WebhookHandler
{
    public function dismiss()
    {
        // ... other logic

        $newKeyboard = $this->originalKeyboard
            ->deleteButton('Dismiss'); 

        $this->replaceKeyboard($newKeyboard);
    }
}
```
```

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

### Handle /start Command

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/6.build-your-first-bot.md

Implement a custom webhook handler to process the /start command and send a welcome message. Ensure the method is public.

```php
<?php

namespace App\Http\Webhooks;

use DefStudio\Telegraph\Handlers\WebhookHandler;

class FirstBotWebhookHandler extends WebhookHandler
{
    public function start(): void
    {
        $this->chat
            ->html('Hello! Telegraph is connected.')
            ->send();
    }
}
```

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

### store()

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Downloads a media file and stores it in the given path.

```APIDOC
## store()

### Description
Downloads a media file and stores it in the given path.

### Method
```php
$telegraphBot->store($photo, Storage::path('bot/images'), 'The Photo.jpg');
```

### Parameters
#### Path Parameters
- **photo** (DefStudio\Telegraph\DTO\Photo) - Required - The photo object to store.
- **path** (string) - Required - The storage path.
- **filename** (string) - Required - The desired filename.
```

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

### Retrieve endpoint URL

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Get the configured endpoint URL for the chat.

```php
/** @var \DefStudio\Telegraph\Models\TelegraphChat $telegraphChat */

$telegraphChat->getUrl();
```

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

### Define a Reply Keyboard with ReplyKeyboard object

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/4.reply-keyboards.md

Use the ReplyKeyboard::make() method to fluently define buttons and properties before attaching the keyboard to a message.

```php
use DefStudio\Telegraph\Keyboard\ReplyButton;
use DefStudio\Telegraph\Keyboard\ReplyKeyboard;

Telegraph::message('hello world')
    ->replyKeyboard(ReplyKeyboard::make()->buttons([
       ReplyButton::make('danger Button')->style(\DefStudio\Telegraph\Enums\ButtonStyle::danger),
       ReplyButton::make('foo')->requestPoll(),
       ReplyButton::make('bar')->requestQuiz(),
       ReplyButton::make('baz')->webApp('https://webapp.dev'),
    ]))->send();
```

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

### Get Chat Administrators

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Retrieves a list of administrators in a chat, excluding bots.

```php
Telegraph::chatAdministrators()->send();
```

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

### Configure Cache Storage Driver

Source: https://github.com/defstudio/telegraph/blob/main/docs/16.storage/1.entities_storage.md

Set up the cache storage driver by defining the driver class, cache store, and key prefix in the configuration. This utilizes Laravel's cache system.

```php
// /config/telegraph.php

return [
    // ...

    'storage' => [
        'stores' => [
            'cache' => [
                'driver' => \DefStudio\Telegraph\Storage\CacheStorageDriver::class,
                'store' => 'redis',
                'key_prefix' => 'tgph',
            ]
        ]       
    ]
]
```

```php
with the above configuration this code will store the `name`
value inside Laravel Redis Cache

$telegraphUser->storage('cache')->put('name', 'Daniele');
```

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

### Get Chat Member Count

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Retrieves the total number of members in a chat.

```php
Telegraph::chatMemberCount()->send();
```

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

### Implementing Custom Storage

Source: https://github.com/defstudio/telegraph/blob/main/docs/16.storage/1.entities_storage.md

To create a custom storage solution, implement the Storable contract and use the HasStorage trait. Define a unique storageKey for each instance.

```php
class MyCustomClass implements \DefStudio\Telegraph\Contracts\Storable
{
    use \DefStudio\Telegraph\Concerns\HasStorage;

    public function storageKey(): string|int
    {
        return "MyCustomClass instance unique ID";
    }
}
```

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

### Publish and Run Telegraph Migrations

Source: https://github.com/defstudio/telegraph/blob/main/README.md

Publish and run the required database migrations for the Telegraph package.

```bash
php artisan vendor:publish --tag="telegraph-migrations"
```

```bash
php artisan migrate
```

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

### Get User Profile Photos

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Retrieves the profile photos for a given user ID.

```php
Telegraph::userProfilePhotos($userId)->send();
```

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

### Get File Info

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/1.bots.md

Retrieves information about a file from Telegram using its file ID.

```php
Telegraph::getFileInfo($fileId)->send();
```

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

### Run Database Migrations

Source: https://github.com/defstudio/telegraph/blob/main/docs/2.installation.md

Execute all pending database migrations, including those for Telegraph.

```bash
php artisan migrate
```

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

### Run Package Tests

Source: https://github.com/defstudio/telegraph/blob/main/README.md

Execute the package tests using Composer.

```bash
composer test
```

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

### Get Chat Member

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Retrieves information about a specific chat member using their user ID.

```php
Telegraph::chatMember($userId)->send();
```

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

### Set Reply Keyboard Button Widths

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/4.reply-keyboards.md

Control button layout by setting relative widths as floats between 0 and 1. Buttons flow to subsequent rows if there is insufficient space.

```php
use DefStudio\Telegraph\Keyboard\ReplyKeyboard;

$keyboard = ReplyKeyboard::make()
    ->button('Text')
    ->button('Send Contact')->requestContact()
    ->button('Send Location')->requestLocation()
    ->button('Create Quiz')->requestQuiz()
    ->button('Create Poll')->requestPoll()
    ->button('Start WebApp')->webApp('https://web.app.dev');
```

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

### Get Chat Menu Button

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Retrieves the current menu button information for a bot's chat.

```php
Telegraph::chatMenuButton()->send();
```

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

### store()

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/1.bots.md

Downloads a media file and stores it in the specified path. Note the hard limit of 20MB for downloaded file sizes imposed by Telegram.

```APIDOC
## `store()`

Downloads a media file and stores it in the given path

```php
/** @var DefStudio\Telegraph\DTO\Photo $photo */

Telegraph::store($photo, Storage::path('bot/images'), 'The Photo.jpg');
```

> [!WARNING]
> There is an hard limit of 20BM for downloaded files sizes. This is a Telegram limitation for bots, sadly, there is no workaround available.
> refer the [docs](https://core.telegram.org/bots/api#getfile) for more info.
```

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

### Register Webhook with Options (CLI)

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/2.registering-webhooks.md

Register a webhook using the Artisan CLI with additional options like dropping pending updates, setting max connections, and providing a secret token.

```shell
php artisan telegraph:set-webhook {bot_id} \
    --drop-pending-updates \
    --max-connections=100 \
    --secret=your-secret-token
```

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

### Get Webhook Debug Info

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/1.bots.md

Retrieves debug information related to the active bot's webhook.

```php
$response = Telegraph::getWebhookDebugInfo()->send();
```

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

### Get Bot Updates

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/1.bots.md

Retrieves updates for the bot from Telegram. Manual polling is unavailable if a webhook is configured.

```php
Telegraph::bot($telegraphBot)->botUpdates()->send();
```

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

### Configure and Send Invoice

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/11.payments.md

Use the invoice method to configure payment details, including currency, items, and optional user requirements.

```php
Telegraph::invoice('Invoice title')
        ->description('Invoice Description')
        ->currency('EUR') //Pass “XTR” for payments in Telegram Stars
        ->addItem('First Item Label', 10)  //Must contain exactly one item for payments in Telegram Stars
        ->addItem('Second Item Label', 10) 
        ->maxTip(70) //Not supported for payments in Telegram Stars
        ->suggestedTips([30,20])
        ->startParameter(10)
        ->image('Invoice Image Link', 20 , 20)
        ->needName() //Ignored for payments in Telegram Stars
        ->needPhoneNumber() //Ignored for payments in Telegram Stars
        ->needEmail() //Ignored for payments in Telegram Stars
        ->needShippingAddress() //Ignored for payments in Telegram Stars
        ->flexible() //Ignored for payments in Telegram Stars
        ->send();
```

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

### Set Locale and Reply in PHP

Source: https://github.com/defstudio/telegraph/blob/main/docs/18.community/2.translating.md

Set the application's locale based on the user's language code and then reply with a translated string. Ensure the translation files are correctly set up.

```php
App::setLocale($this->message->from()->languageCode());

$this->reply(__('Hello')); // Ciao!
```

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

### Create Purchase Button

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/11.payments.md

Define a button in the chat keyboard that triggers a purchase action with specific parameters.

```php
public function exampleButton(): void
{
    $this->chat->message('Table')
       ->keyboard(fn(Keyboard $keyboard) => $keyboard->button('Buy')->action('buy')->param('item_id', 42));
}
```

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

### Get Chat Info

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Retrieves detailed information about the chat. The response includes chat ID, type, title, and other relevant data.

```php
Telegraph::chatInfo()->send();

/*
id: xxxxx
type: group
title: my telegram group
...
*/
```

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

### Send a document

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/3.messages.md

Use the `document()` method to send a file as a document. Provide the path to the document file.

```php
Telegraph::document($documentPath)->send();
```

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

### Publish Telegraph Configuration and Translations

Source: https://github.com/defstudio/telegraph/blob/main/README.md

Optionally publish the configuration and translation files for the Telegraph package.

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

```bash
php artisan vendor:publish --tag="telegraph-translations"
```

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

### Get Bot Updates with Long Polling Timeout

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/1.bots.md

Retrieves bot updates using long polling, specifying a timeout for production environments.

```php
Telegraph::bot($telegraphBot)->botUpdates(timeout: 60)->send();
```

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

### Create Invite Link

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Creates an additional invite link with optional parameters like name, expiration, member limit, and join request requirements.

```php
use DefStudio\Telegraph\Models\TelegraphChat;

/** @var TelegraphChat $telegraphChat */

$telegraphChat->createInviteLink()
    ->name('September promotional link')    //optional
    ->expire(today()->addMonth())           //optional
    ->memberLimit(42)                       //optional
    ->withJoinRequest()                     //optional
    ->send();
```

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

### Retrieving the Message ID with telegraphMessageId

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/6.telegraph-response.md

Get the ID of the message posted on the Telegraph chat. Returns null if the request failed or no message was posted.

```php
$response = Telegraph::message('hello')->send();

$response->telegraphMessageId(); //4568
```

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

### Clear Cache, Set, and Debug Webhook (General)

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/7.troubleshooting.md

Clear configuration cache, set the webhook, and then debug it. This is a general troubleshooting step for webhook issues.

```shell
php artisan config:clear
php artisan telegraph:set-webhook {bot_id}
php artisan telegraph:debug-webhook {bot_id}
```

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

### Configure Environment Variables

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/6.build-your-first-bot.md

Set up essential environment variables for Telegraph. Replace placeholders with your actual application URL, bot token, and a secret token for webhook security.

```dotenv
APP_URL=https://example.test
TELEGRAM_WEBHOOK_DOMAIN=https://example.test
TELEGRAPH_BOT_TOKEN=replace-with-botfather-token
TELEGRAPH_WEBHOOK_SECRET=replace-with-a-random-secret
```

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

### Dump Sent Data for Debugging

Source: https://github.com/defstudio/telegraph/blob/main/docs/17.testing/1.fake.md

Use Telegraph::dumpSentData() after faking requests to get a dump of all data that would have been sent to Telegram. This is useful for debugging.

```php
Telegraph::fake();

// Telegraph requests...

Telegraph::dumpSentData();

```

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

### Get File Info

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Retrieve information about a file using its file ID with the `getFileInfo()` method. This returns metadata about the file, such as its path on Telegram servers.

```php
$telegraphBot->getFileInfo($fileId)->send();
```

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

### Create a Forum Topic

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Creates a new forum topic in the chat using the createForumTopic method.

```php
/** @var DefStudio\Telegraph\Models\TelegraphChat $telegraphChat */
$telegraphChat->createForumTopic('topic name', 7322096, 'emoji_id')->send();
```

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

### Attach a keyboard using an array

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/3.keyboards.md

Define keyboard buttons using the buttons method with an array of Button objects.

```php
use DefStudio\Telegraph\Keyboard\Button;
use DefStudio\Telegraph\Keyboard\Keyboard;

Telegraph::message('hello world')
->keyboard(Keyboard::make()->buttons([
        Button::make('Danger Button')->url('https://test.it')->style(\DefStudio\Telegraph\Enums\ButtonStyle::danger),
        Button::make('Delete')->action('delete')->param('id', '42'),
        Button::make('open')->url('https://test.it'),
        Button::make('Web App')->webApp('https://web-app.test.it'),
        Button::make('Login Url')->loginUrl('https://loginUrl.test.it'),
]))->send();
```

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

### Get Bot Information

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Fetch bot information from Telegram APIs using the `info()` method. This returns details about the bot's configuration and capabilities.

```php
/** @var \DefStudio\Telegraph\Models\TelegraphBot $telegraphBot */

$telegraphBot->info();


/*
id: xxxxx
is_bot: true
first_name: telegraph-test
username: my_test_bot
can_join_groups: true
can_read_all_group_messages: false
supports_inline_queries: false
*/
```

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

### Temporarily Allow Unknown Chats

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/7.troubleshooting.md

Configure Telegraph to temporarily allow messages from chats that are not yet registered. This is useful during the initial setup or onboarding phase.

```php
'security' => [
    'allow_messages_from_unknown_chats' => true,
]
```

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

### Handle Poll Answer Received

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Override this method to process an answer submitted by a user to a poll. This example sends a notification to the first chat associated with the bot.

```php
class CustomWebhookHandler extends WebhookHandler
{
    protected function handlePollAnswer(PollAnswer $pollAnswer): void
    {
        $this->bot->chats->first()->html('Poll answer received')->send();
    }
}
```

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

### Publish Telegraph Migrations

Source: https://github.com/defstudio/telegraph/blob/main/docs/2.installation.md

Publish the package's migration files to your application.

```bash
php artisan vendor:publish --tag="telegraph-migrations"
```

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

### Configure payment provider token

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/7.attachments.md

Set the provider token in the environment file or via the providerData method.

```env
TELEGRAPH_PAYMENT_PROVIDER_TOKEN = "provider token"
```

```php
Telegraph::invoice('Invoice title')
        ->description('Invoice Description')
        ->currency('EUR')
        ->addItem('Item Label', 10)
        ->providerData('provider token')
        ->send();
```

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

### Programmatically Create a New Bot

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/2.register-new-bot.md

Create a new bot instance programmatically using the TelegraphBot model, providing the token and a name.

```php
use DefStudio\Telegraph\Models\TelegraphBot;

$bot = TelegraphBot::create([
    'token' => config('services.telegram.bot_token'),
    'name' => 'Support Bot',
]);
```

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

### Get Bot Updates with Long Polling

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Enable long polling for manual updates by specifying a `timeout` in seconds. This reduces the frequency of requests when no updates are available.

```php
$telegraphBot->updates(timeout: 60)->each(function(TelegramUpdate $update){
    // ...
});
```

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

### Register Webhook with Options

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/6.build-your-first-bot.md

Register the webhook with additional options like dropping pending updates and setting a secret for enhanced security. Ensure the secret is exported to your shell environment.

```shell
export TELEGRAPH_WEBHOOK_SECRET="replace-with-a-random-secret"
php artisan telegraph:set-webhook 1 --drop-pending-updates --secret="${TELEGRAPH_WEBHOOK_SECRET}"
```

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

### Get Webhook Debug Info

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Retrieve debug information about your bot's webhook using the `getWebhookDebugInfo()` method. This can help diagnose issues with webhook delivery.

```php
/** @var \DefStudio\Telegraph\Models\TelegraphBot $telegraphBot */

$telegraphBot->getWebhookDebugInfo()->send();
```

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

### Get Bot URL

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Retrieve the bot's Telegram API URL using the `url()` method. This is useful for constructing direct API request URLs.

```php
/** @var \DefStudio\Telegraph\Models\TelegraphBot $telegraphBot */

$telegraphBot->url();

// https://t.me/my-bot-name
```

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

### Configure Application URL

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/2.registering-webhooks.md

Set the main application URL in your .env file. This is used by your application to construct URLs.

```dotenv
APP_URL=https://example.ngrok-free.app
```

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

### Send a contact

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/3.messages.md

Use the `contact()` method to share a contact. Provide the phone number and optionally the first name.

```php
Telegraph::contact('3331122111', 'firstName')->send();
```

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

### Handle Poll State Update

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Override this method to react to changes in a poll's state. This example sends a generic message to the first chat associated with the bot.

```php
class CustomWebhookHandler extends WebhookHandler
{
    protected function handlePollStateUpdate(Poll $poll): void
    {
        $this->bot->chats->first()->html('Poll state updated')->send();
    }
}
```

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

### Reply to Callback Query with Tooltip

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/6.callback-reply.md

Use the `reply()` method within your webhook handler to send a visual tooltip notification to the user. This is useful for confirming actions or providing brief messages.

```php
class CustomWebhookHandler extends WebhookHandler
{
    public function dismiss(){
        //...

        $this->reply("Notification dismissed");
    }
}
```

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

### Handle Message Reactions

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Override `handleChatReaction` to process events related to adding or removing reactions to messages. This example sends back the emoji of the first new reaction.

```php
class CustomWebhookHandler extends WebhookHandler
{
    protected function handleChatReaction(array $newReactions, array $oldReactions): void
    {
        // in this example, a received emoji message is sent back to the chat
        $this->chat->html("Received: " . $newReactions[0]['emoji'])->send();
    }
}
```

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

### Get Bot Updates (Manual Polling)

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Retrieve bot updates using manual polling with the `updates()` method. This is an alternative to webhooks for receiving messages and callback queries.

```php
/** @var \DefStudio\Telegraph\Models\TelegraphBot $telegraphBot */

$telegraphBot->updates()->each(function(TelegramUpdate $update){
    // ...
});
```

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

### Configure File Storage Driver

Source: https://github.com/defstudio/telegraph/blob/main/docs/16.storage/1.entities_storage.md

Configure the file storage driver by specifying the driver class, disk, and root path in the configuration file. Data is stored in JSON files.

```php
// /config/telegraph.php

return [
    // ...

    'storage' => [
        'stores' => [
            'file' => [
                'driver' => \DefStudio\Telegraph\Storage\FileStorageDriver::class,
                'disk' => 'local',
                'root' => 'telegraph',
            ]
        ]       
    ]
]
```

```php
with the above configuration this code will store the `name`
value in a `/[laravel local disk path]/telegraph/User/<telegraph_user_id>.json` file

$telegraphUser->storage('file')->put('name', 'Daniele');
```

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

### Attach a keyboard using a closure

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/3.keyboards.md

Define keyboard buttons fluently within a closure passed to the keyboard method.

```php
use DefStudio\Telegraph\Keyboard\Keyboard;

Telegraph::message('hello world')
->keyboard(function(Keyboard $keyboard){
    return $keyboard
        ->button('Danger Button')->url('https://test.it')->style(\DefStudio\Telegraph\Enums\ButtonStyle::danger)
        ->button('Delete')->action('delete')->param('id', '42')
        ->button('open')->url('https://test.it')
        ->button('Web App')->webApp('https://web-app.test.it')
        ->button('Login Url')->loginUrl('https://loginUrl.test.it')
        ->button('Copy to Clipboard')->copyText('https://example.com/share/123');
})->send();
```

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

### Register Webhook Programmatically with Secret Token

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/2.registering-webhooks.md

Register a webhook programmatically in PHP, providing the secret token via configuration. This method is useful for dynamic webhook setup.

```php
/** @var DefStudio\Telegraph\Models\TelegraphBot $telegraphBot */

$telegraphBot->registerWebhook(
    secretToken: config('telegraph.webhook.secret'),
)->send();
```

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

### Send a photo

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/3.messages.md

Use the `photo()` method to send an image file. Provide the path to the photo file.

```php
Telegraph::photo($pathToPhotoFile)->send();
```

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

### Handle Bot Chat Status Update Webhook

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Implement the handleBotChatStatusUpdate method to react to changes in the bot's status within a chat. This example shows sending a message when the bot is blocked.

```php
class CustomWebhookHandler extends WebhookHandler
{
    protected function handleBotChatStatusUpdate(ChatMemberUpdate $chatMemberUpdate): void
    {
        $this->chat->html('I have been blocked by Mario')->send();
    }
}
```

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

### Set Webhook and Drop Pending Updates

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/7.troubleshooting.md

Register the webhook and instruct Telegram to drop any pending updates. This is useful during setup to ensure only new messages are processed and to clear any backlog of old messages.

```shell
php artisan telegraph:set-webhook {bot_id} --drop-pending-updates
```

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

### Handle a basic chat command

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Define a public method in your webhook handler that matches the command name (e.g., 'hi' for '/hi'). This method will be executed when the command is received.

```php
class CustomWebhookHandler extends WebhookHandler
{
    public function hi()
    {
        $this->chat->markdown("*Hi* happy to be here!")->send();
    }
}
```

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

### Handling Inline Queries in Webhook Handler

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Override the 'handleInlineQuery' method in your custom webhook handler to process user's inline queries. This example searches for a logo based on the query and prepares results.

```php
use DefStudio\Telegraph\DTO\InlineQuery;
use DefStudio\Telegraph\DTO\InlineQueryResultPhoto;

class CustomWebhookHandler extends WebhookHandler
{
    public function handleInlineQuery(InlineQuery $inlineQuery): void
    {
        $query = $inlineQuery->query(); // "pest logo"

        $logo = LogoFinder::search($query); // the code to handle the query. just an example here

        $this->bot->answerInlineQuery($inlineQuery->id(), [
            InlineQueryResultPhoto::make($logo->id."-light", "https://logofinder.dev/$logo->id/light.jpg", "https://logofinder.dev/$logo->id/light/thumb.jpg")
                ->caption('Light Logo'),
            InlineQueryResultPhoto::make($logo->id."-dark", "https://logofinder.dev/$logo->id/dark.jpg", "https://logofinder.dev/$logo->id/dark/thumb.jpg")
                ->caption('Light Logo'),
        ])->send();
    }
}
```

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

### Configure Default Storage Driver

Source: https://github.com/defstudio/telegraph/blob/main/docs/16.storage/1.entities_storage.md

Set the default storage driver in the 'telegraph.storage.default' configuration key. This driver is used when ->storage() is called without arguments.

```php
// /config/telegraph.php

return [
    // ...

    'storage' => [
        'default' => 'file'
    ]
]
```

```php
$telegraphUser->storage() // \DefStudio\Telegraph\Storage\FileStorageDriver
```

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

### Configure right-to-left keyboard layout

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/3.keyboards.md

Enables right-to-left layout for keyboard buttons using the rightToLeft method.

```php
use DefStudio\Telegraph\Keyboard\Button;
use DefStudio\Telegraph\Keyboard\Keyboard;

$keyboard = Keyboard::make()
    ->row([
        Button::make('Delete')->action('delete')->param('id', '42'),
        Button::make('Dismiss')->action('dismiss')->param('id', '42'),
    ])
    ->row([
        Button::make('open')->url('https://test.it'),
    ])
    ->rightToLeft();
```

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

### Fake Webhook Command Flow Assertion

Source: https://github.com/defstudio/telegraph/blob/main/docs/17.testing/1.fake.md

For webhook command flows, call Telegraph::fake() before handling the request and assert the fake payload afterwards. This example demonstrates asserting a '/start' command response.

```php
use DefStudio\Telegraph\Facades\Telegraph;
use DefStudio\Telegraph\Telegraph as TelegraphCore;

Telegraph::fake();

// Handle the webhook request for /start...

Telegraph::assertSentData(TelegraphCore::ENDPOINT_MESSAGE, [
    'chat_id' => '-123456789',
    'text' => 'Hello! Telegraph is connected.',
]);

```

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

### Publish Telegraph Configuration File

Source: https://github.com/defstudio/telegraph/blob/main/docs/2.installation.md

Publish the Telegraph configuration file to your application's config directory.

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

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

### Handle Chat Messages with Contact Information

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Process chat messages containing contact information by overriding `handleChatMessage`. This example checks if the sent contact's user ID matches the sender's ID.

```php
class CustomWebhookHandler extends WebhookHandler
{
    protected function handleChatMessage(Stringable $text): void
    {
        // checks that the contact matches the sender ID

        $contactUserId = $this->message->contact()->userId();
        $senderId = $this->message->from()->id();

        if($contactUserId == $senderId){
            $this->reply('this is your contact');
        }else{
            $this->reply('this is NOT your contact');  
        }
    }
}
```

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

### Handle Plain Chat Messages

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/4.webhook-request-types.md

Override `handleChatMessage` to process plain text messages. This example echoes the received text back to the chat. Ensure bot privacy mode is disabled to receive non-command messages.

```php
class CustomWebhookHandler extends WebhookHandler
{
    protected function handleChatMessage(Stringable $text): void
    {
        // in this example, a received message is sent back to the chat
        $this->chat->html("Received: $text")->send();
    }
}
```

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

### Send a document

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Sends a document from a specified path.

```php
$telegraphChat->document($documentPath)->send();
```

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

### replyWebhook()

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Replies to a webhook callback query.

```APIDOC
## replyWebhook()

### Description
Replies to a webhook callback.

### Method
```php
$telegraphBot->replyWebhook($callbackQueryId, 'message received', $showAlert)->send();
```
```

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

### Send an invoice

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Sends an invoice with a title, description, currency, and items.

```php
$telegraphChat->invoice('Invoice title')
        ->description('Invoice Description')
        ->currency('EUR')
        ->addItem('Item Label', 10) 
        ->send();
```

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

### Expose Bot Token in Service Configuration

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/2.register-new-bot.md

Configure your application to access the bot token from the services configuration file.

```php
'telegram' => [
    'bot_token' => env('TELEGRAM_BOT_TOKEN'),
]
```

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

### Send an audio file

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Sends an audio attachment.

```php
/** @var DefStudio\Telegraph\Models\TelegraphChat $telegraphChat */
$telegraphChat->audio()->send();
```

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

### menuButton()

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Retrieves the current chat menu button configuration.

```APIDOC
## menuButton()

### Description
Retrieves chat menu button.

### Usage
```php
/** @var DefStudio\Telegraph\Models\TelegraphChat $telegraphChat */
$button = $telegraphChat->menuButton()->send();
```
```

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

### registerWebhook()

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Registers a webhook URL for the bot.

```APIDOC
## registerWebhook()

### Description
Register a webhook url.

### Method
```php
$telegraphBot->registerWebhook()->send();
```

### Parameters
#### Query Parameters
- **dropPendingUpdates** (boolean) - Optional - drops pending updates from telegram
- **maxConnections** (integer) - Optional - maximum allowed simultaneous connections to the webhook (defaults to 40)
- **secretToken** (string) - Optional - secret token to be sent in a `X-Telegram-Bot-Api-Secret-Token` header to verify the authenticity of the webhook
```

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

### Create an invoice link

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/7.attachments.md

Generate a link for an invoice instead of sending it directly.

```php
Telegraph::invoice('Invoice title')
        ->description('Invoice Description')
        ->currency('EUR')
        ->addItem('Item Label', 10)
        ->link()
        ->send();
```

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

### createInviteLink()

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Creates an additional invite link for a chat with optional configuration.

```APIDOC
## createInviteLink()

### Description
Creates an additional invite link for a chat.

### Method
`createInviteLink()`

### Parameters
- **name** (string) - Optional - Name of the invite link
- **expire** (DateTime) - Optional - Expiration date
- **memberLimit** (int) - Optional - Maximum number of members
- **withJoinRequest** (bool) - Optional - Whether to require join requests

### Usage
```php
$telegraphChat->createInviteLink()
    ->name('September promotional link')
    ->expire(today()->addMonth())
    ->memberLimit(42)
    ->withJoinRequest()
    ->send();
```
```

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

### Create a persistent reply keyboard

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/4.reply-keyboards.md

Use the persistent method to keep the keyboard visible even when the regular keyboard is hidden.

```php
use DefStudio\Telegraph\Keyboard\ReplyKeyboard;

$keyboard = ReplyKeyboard::make()
    ->button('Send Contact')->requestContact()
    ->button('Send Location')->requestLocation()
    ->persistent();
```

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

### Send a video note

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Sends a video note attachment.

```php
/** @var DefStudio\Telegraph\Models\TelegraphChat $telegraphChat */
$telegraphChat->videoNote()->send();
```

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

### Send optional parameters with attachments

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/7.attachments.md

Use withData() to include optional parameters when sending messages.

```php
Telegraph::message('hi')->withData('caption', 'test')->send();
Telegraph::withData('caption', 'test')->message('hi')->send();
```

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

### Set Chat Menu Button

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Configures the menu button for a chat. This can restore the default, show bot commands, or launch a web app.

```php
Telegraph::setChatMenuButton()->default()->send(); //restore default
Telegraph::setChatMenuButton()->commands()->send(); //show bot commands in menu button
Telegraph::setChatMenuButton()->webApp("Web App", "https://my-web.app")->send(); //show start web app button
```

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

### Replace Chat Keyboard with New Keyboard

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/7.keyboard-interaction.md

Use the `->replaceKeyboard()` method to substitute the entire current keyboard with a new one. This is useful for updating the available options or changing the keyboard's layout.

```php
class CustomWebhookHandler extends WebhookHandler
{
    public function dismiss(){
        //...

        $newKeyboard = $this->originalKeyboard
            ->deleteButton('Dismiss'); 

        $this->replaceKeyboard($newKeyboard);
    }
}
```

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

### Send a photo

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Sends a photo file from the local storage path.

```php
use DefStudio\Telegraph\Models\TelegraphChat;

/** @var TelegraphChat $telegraphChat */

$telegraphChat->photo(Storage::path('photo.jpg'))->send();
```

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

### Send a Message with Telegraph Facade

Source: https://github.com/defstudio/telegraph/blob/main/README.md

Use the Telegraph facade to send a simple message. Ensure a bot is created and added to a chat/group/channel before use.

```php
Telegraph::message('this is great')->send();
```

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

### createForumTopic

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Creates a new forum topic in the chat.

```APIDOC
## createForumTopic

### Description
Creates a new forum topic within the chat.

### Method
`$telegraphChat->createForumTopic(string $name, int $iconColor, string $iconEmojiId)->send()`

### Parameters
- **name** (string) - Required - The name of the topic.
- **iconColor** (int) - Required - The color of the topic icon.
- **iconEmojiId** (string) - Required - The emoji ID for the topic icon.
```

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

### Fake with Custom Responses

Source: https://github.com/defstudio/telegraph/blob/main/docs/17.testing/1.fake.md

The fake() helper can accept an array of custom responses for specific endpoint calls during testing. This allows simulating API responses.

```php
Telegraph::fake([
   \DefStudio\Telegraph\Telegraph::ENDPOINT_MESSAGE => ['result' => 'oooook'],
]);

$response = Telegraph::message('foo')->send();

//$response will be a Response containing a json body: {"result":"oooook"}

```

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

### Store Media File

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Download a media file from Telegram and store it locally using the `store()` method. This method takes a file DTO, a storage path, and a filename.

```php
/** @var DefStudio\Telegraph\DTO\Photo $photo */

$telegraphBot->store($photo, Storage::path('bot/images'), 'The Photo.jpg');
```

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

### info()

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/1.telegraph-bot.md

Retrieves bot information from Telegraph APIs.

```APIDOC
## info()

### Description
Retrieves the bot information from Telegraph APIs.

### Method
```php
$telegraphBot->info();
```

### Response Example
```json
{
  "id": "xxxxx",
  "is_bot": true,
  "first_name": "telegraph-test",
  "username": "my_test_bot",
  "can_join_groups": true,
  "can_read_all_group_messages": false,
  "supports_inline_queries": false
}
```
```

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

### Send Invoice

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/11.payments.md

Implement a function to create an invoice record and send the invoice message to the chat.

```php
public function buy(int $item_id): void
{
   $invoice = InvoiceModel::create([...]);

   $this->chat->invoice('Attached is the invoice for your order')
        ->currency('EUR')
        ->addItem('Table', 100)
        ->payload($invoice->id)
        ->send();
}
```

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

### Define Switch Inline Query Buttons

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/3.keyboards.md

Prompts the user to select a chat to insert the bot's username and query. Use currentChat() to skip the chat selection prompt.

```php
Button::make('switch')->switchInlineQuery('foo'),
```

```php
Button::make('switch')->switchInlineQuery('foo')->currentChat(),
```

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

### List All Routes

Source: https://github.com/defstudio/telegraph/blob/main/docs/11.quickstart/7.troubleshooting.md

Verify that the webhook route exists in your Laravel application. This is useful if the webhook path itself has changed.

```shell
php artisan route:list
```

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

### Apply conditional keyboard buttons

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/3.keyboards.md

Uses the when method to conditionally add buttons to a keyboard based on a boolean expression.

```php
Keyboard::make()
    ->button('Dismiss')->action('dismiss')->param('id', '42')->width(0.5)
    ->when($userCanDelete, fn(Keyboard $keyboard) => $keyboard->button('Delete')->action('delete')->param('id', '42')->width(0.5))
```

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

### chatMenuButton()

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Retrieves the current menu button information for a bot.

```APIDOC
## chatMenuButton()

Retrieves a bot current menu button info.

### Method
GET

### Endpoint
/chatMenuButton

### Response
#### Success Response (200)
- **button** (object) - Information about the current menu button.

### Response Example
```json
{
  "button": { ... }
}
```

### Request Example
```php
Telegraph::chatMenuButton()->send();
```
```

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

### setMenuButton()

Source: https://github.com/defstudio/telegraph/blob/main/docs/14.models/2.telegraph-chat.md

Sets the chat menu button configuration.

```APIDOC
## setMenuButton()

### Description
Set chat menu button.

### Usage
```php
/** @var DefStudio\Telegraph\Models\TelegraphChat $telegraphChat */
$telegraphChat->setMenuButton()->default()->send(); //restore default
$telegraphChat->setMenuButton()->commands()->send(); //show bot commands in menu button
$telegraphChat->setMenuButton()->webApp("Web App", "https://my-web.app")->send(); //show start web app button
```
```

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

### Send Venue

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/7.attachments.md

Sends a venue attachment with coordinates, title, and address.

```php
Telegraph::venue(10, 10, 'title', 'address')->send();
```

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

### Define a Reply Keyboard with a closure

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/4.reply-keyboards.md

Attach a keyboard to a message by passing a closure to the replyKeyboard method for a more concise fluent interface.

```php
use DefStudio\Telegraph\Keyboard\Keyboard;

Telegraph::message('hello world')
->replyKeyboard(function(Keyboard $keyboard){
    return $keyboard
        ->button('danger')->style(\DefStudio\Telegraph\Enums\ButtonStyle::danger)
        ->button('foo')->requestPoll()
        ->button('bar')->requestQuiz()
        ->button('baz')->webApp('https://webapp.dev');
})->send();
```

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

### Clear Config and Set Webhook

Source: https://github.com/defstudio/telegraph/blob/main/docs/15.webhooks/2.registering-webhooks.md

Clear the application configuration cache and then register a webhook with a specific bot ID and a secret token. This is useful when the debug webhook shows an old URL.

```shell
php artisan config:clear
php artisan telegraph:set-webhook {bot_id} --secret=your-secret-token
```

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

### Create a One-Time Keyboard

Source: https://github.com/defstudio/telegraph/blob/main/docs/12.features/4.reply-keyboards.md

The oneTime method requests the client to hide the keyboard immediately after a button is pressed.

```php
use DefStudio\Telegraph\Keyboard\ReplyKeyboard;

$keyboard = ReplyKeyboard::make()
    ->button('Send Contact')->requestContact()
    ->button('Send Location')->requestLocation()
    ->oneTime();
```

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

### Set Chat Title

Source: https://github.com/defstudio/telegraph/blob/main/docs/13.api/2.chats.md

Sets a new title for the chat.

```php
Telegraph::setTitle("my chat")->send();
```
Tokens:
Raw