Core

<h1 align="center">The development of the project is currently on hold until further notice. We will provide updates as soon as they become available.</h1> <h1 align="center"> PHP Telegram Bot<br> <br> <img src="https://raw.githubusercontent.com/php-telegram-bot/assets/master/logo/512px/logo_plain.png" title="PHP Telegram Bot" alt="PHP Telegram Bot logo"> <br> </h1>

A Telegram Bot based on the official [Telegram Bot API]

[][Tidelift]

Table of Contents

• Introduction
• Instructions
  • Create your first bot
  • Require this package with Composer
  • Choose how to retrieve Telegram updates
• Using a custom Bot API server
• Webhook installation
  • Self Signed Certificate
  • Unset Webhook
• getUpdates installation
  • getUpdates without database
• Filter Update
• Support
  • Types
  • Inline Query
  • Methods
  • Send Message
  • Send Photo
  • Send Chat Action
  • getUserProfilePhoto
  • getFile and downloadFile
  • Send message to all active chats
• Utils
  • MySQL storage (Recommended)
    • External Database connection
  • Channels Support
• Commands
  • Predefined Commands
  • Custom Commands
  • Commands Configuration
  • Admin Commands
    • Set Admins
    • Channel Administration
• Upload and Download directory path
• Logging
• Documentation
• Assets
• Example bot
• Projects with this library
• Troubleshooting
• Contributing
• Security
• Donate
• For enterprise
• License
• Credits

Introduction

This is a pure PHP Telegram Bot, fully extensible via plugins.

Telegram announced official support for a Bot API, allowing integrators of all sorts to bring automated interactions to the mobile platform. This Bot aims to provide a platform where one can simply write a bot and have interactions in a matter of minutes.

The Bot can:

• Retrieve updates with webhook and getUpdates methods.
• Supports all types and methods according to Telegram Bot API 7.1 (February 2024).
• Supports supergroups.
• Handle commands in chat with other bots.
• Manage Channel from the bot admin interface.
• Full support for inline bots.
• Inline keyboard.
• Messages, InlineQuery and ChosenInlineQuery are stored in the Database.
• Conversation feature.

---

This code is available on GitHub. Pull requests are welcome.

Instructions

Create your first bot

1. Message @BotFather with the following text: /newbot

   If you don't know how to message by username, click the search field on your Telegram app and type @BotFather, where you should be able to initiate a conversation. Be careful not to send it to the wrong contact, because some users have similar usernames to BotFather.

   

2. @BotFather replies with:

   Alright, a new bot. How are we going to call it? Please choose a name for your bot.
   

3. Type whatever name you want for your bot.

4. @BotFather replies with:

   Good. Now let's choose a username for your bot. It must end in `bot`. Like this, for example: TetrisBot or tetris_bot.
   

5. Type whatever username you want for your bot, minimum 5 characters, and must end with bot. For example: telesample_bot

6. @BotFather replies with:

   Done! Congratulations on your new bot. You will find it at
   telegram.me/telesample_bot. You can now add a description, about
   section and profile picture for your bot, see /help for a list of
   commands.
   
   Use this token to access the HTTP API:
   123456789:AAG90e14-0f8-40183D-18491dDE
   
   For a description of the Bot API, see this page:
   https://core.telegram.org/bots/api
   

7. Note down the 'token' mentioned above.

Optionally set the bot privacy:

1. Send /setprivacy to @BotFather.

   

2. @BotFather replies with:

   Choose a bot to change group messages settings.
   

3. Type (or select) @telesample_bot (change to the username you set at step 5 above, but start it with @)

4. @BotFather replies with:

   'Enable' - your bot will only receive messages that either start with the '/' symbol or mention the bot by username.
   'Disable' - your bot will receive all messages that people send to groups.
   Current status is: ENABLED
   

5. Type (or select) Disable to let your bot receive all messages sent to a group.

6. @BotFather replies with:

   Success! The new status is: DISABLED. /help
   

Require this package with Composer

Install this package through [Composer]. Edit your project's composer.json file to require longman/telegram-bot.

Create composer.json file

{
    "name": "yourproject/yourproject",
    "type": "project",
    "require": {
        "php": "^8.1",
        "longman/telegram-bot": "*"
    }
}

and run composer update

or

run this command in your command line:

composer require longman/telegram-bot

Choose how to retrieve Telegram updates

The bot can handle updates with Webhook or getUpdates method:

| | Webhook | getUpdates | | ---- | :----: | :----: | | Description | Telegram sends the updates directly to your host | You have to fetch Telegram updates manually | | Host with https | Required | Not required | | MySQL | Not required | (Not) Required |

Using a custom Bot API server

For advanced users only!

As from Telegram Bot API 5.0, users can [run their own Bot API server] to handle updates. This means, that the PHP Telegram Bot needs to be configured to serve that custom URI. Additionally, you can define the URI where uploaded files to the bot can be downloaded (note the {API_KEY} placeholder).

Longman\TelegramBot\Request::setCustomBotApiUri(
    $api_base_uri          = 'https://your-bot-api-server', // Default: https://api.telegram.org
    $api_base_download_uri = '/path/to/files/{API_KEY}'     // Default: /file/bot{API_KEY}
);

Note: If you are running your bot in --local mode, you won't need the Request::downloadFile() method, since you can then access your files directly from the absolute path returned by Request::getFile().

Webhook installation

Note: For a more detailed explanation, head over to the [example-bot repository] and follow the instructions there.

In order to set a [Webhook][api-setwebhook] you need a server with HTTPS and composer support. (For a self signed certificate you need to add some extra code)

Create [set.php] with the following contents:

<?php
// Load composer
require __DIR__ . '/vendor/autoload.php';

$bot_api_key  = 'your:bot_api_key';
$bot_username = 'username_bot';
$hook_url     = 'https://your-domain/path/to/hook.php';

try {
    // Create Telegram API object
    $telegram = new Longman\TelegramBot\Telegram($bot_api_key, $bot_username);

    // Set webhook
    $result = $telegram->s