mk4u/tgram

Lightweight Telegram Bot API SDK for PHP.

Maintainers

Package info

github.com/al3x5dev/tgram

pkg:composer/mk4u/tgram

Transparency log

Statistics

Installs: 10

Dependents: 1

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v0.2.1 2026-08-27 20:00 UTC

Requires

Requires (Dev)

MIT 8b9520b4b2c7b1e08a43f76ba5867453ebd70347

phpsdkbottelegramtelegram-botTelegram-API

Published on Packagist.org on 2026-08-27 20:03 UTC

This package is auto-updated.

Last update: 2026-08-27 20:03:53 UTC

README

API Version Version License PHP

Telegram Bot API SDK for PHP.

A lightweight PHP SDK for building Telegram bots with a simple, expressive API and minimal dependencies. Covers the Telegram Bot API (v10.3) with first-class entities and developer-friendly tooling:

  • Entity system — every API response is mapped to an object with dynamic properties: $message->from->first_name.
  • Attribute-driven commands & callbacks — #[Command('/start')], #[Callback('action')] with argument parsing.
  • All update types — commands, callbacks, handlers, conversations and a middleware pipeline.
  • Rich messages (Bot API 10.3 format) — Text, RichMessage and Block builders for beautiful messages.
  • Keyboard factory — fluent inline & reply keyboards (Keyboard::inline(), Keyboard::reply()).
  • Webhook security — X-Telegram-Bot-Api-Secret-Token validation.
  • Built-in CLI — install, scaffold and manage your bot from the terminal.

Note

Before you start creating code, you must have created your bot in Telegram. Here's how to do it.

Requirements

  • PHP >= 8.5

Installation

composer require mk4u/tgram

Quick start

  1. Create config.php with your bot token:
return [
    'token'      => '110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw',
    'secret'     => 'your_secret_token_here',
    'admins'     => [123456789, 985632147],
    'parse_mode' => 'HTML',
    'abs_path'   => __DIR__,
];
  1. Create your entry point (index.php):
require_once 'vendor/autoload.php';

use Mk4U\TGram\Bot;

$bot = new Bot();
$bot->run();
  1. Define a command in bot/Commands/Start.php:
namespace Bot\Commands;

use Mk4U\TGram\Core\Actions\Commands;
use Mk4U\TGram\Attributes\Command;

#[Command('/start')]
class Start extends Commands
{
    public function execute(): void
    {
        $this->reply('Hey there! Welcome to our bot!');
    }

    public static function description(): string
    {
        return 'Start Command to get you started';
    }
}
  1. Register your commands:
php vendor/bin/tgram register

  1. Choose how your bot receives updates:

    • Webhook (recommended for production — requires a public HTTPS URL):

      php vendor/bin/tgram hook:set https://your-domain.com/index.php

    • Long polling (no public URL needed — runs forever in the terminal):

      php vendor/bin/tgram poll

Documentation

License

MIT