README

Lightweight PHP wrapper library for Telegram Bot API

Bot API version: v7.10 (September 6, 2024) - Snapshot Link

Minimal, Doesn't get in your way
Fully documented, Employs identical names for methods and classes as those found in the official API
Uses Guzzle as the HTTP client
Provides type hints for IDE autocompletion
TODO: Complete implementation of all methods and classes
TODO: Concurrent (bulk) requests: Has been experimentally implemented for some methods
TODO: Async requests
TODO: Provide helper utilities (e.g. For formatting messages using HTML or Markdown) and builtin checks (e.g. Making sure the message text's length does not exceed 4096 chars)

Litegram is still in early development stages so expect bugs and non-backward compatible changes.

Use Github Issues for comments, bug reports and questions.

Installation

composer require amirrh6/litegram

Usage

require_once './vendor/autoload.php';

// --- --- --- --- --- --- ---

$token = '0123456789:...';

// --- --- --- --- --- --- ---

use Litegram\TelegramMethods;

try {
    // If the request doesn't fail, an object of type Litegram\User will be returned
    $res = TelegramMethods::getMe(token: $token);
    var_dump('Result:', $res);
} catch (\Throwable $th) {
    var_dump('Exception:', $th);
}

Examples

This file provides usage example for some primary methods.

History

Over a year ago, during my free time between university classes, I started working on another Telegram bot. I wanted to challenge myself by creating my own wrapper library for it. Although the bot project was eventually abandoned, I decided to revive the wrapper library, and here we are today.

License:

GPL 2.0 only

Implemented classes and methods:

* Make sure you view this section on Github rather than Packagist as it doesn't display checkmarks correctly.

Getting updates (4/4 methods implemented, 2/2 classes implemented):

Available types (34/139 classes implemented + 10 union types):

Available methods (7/85 methods implemented):

* Experimental bulk (concurrent) version is available. These methods are named like this: copyMessage() ---> _bulkCopyMessage()

Updating messages (1/9 methods implemented):

Stickers (0/16 methods implemented, 0/4 classes implemented):

Inline mode (0/2 methods implemented, 3/29 classes implemented + 2 union types):

Payments (0/6 methods implemented, 3/19 classes implemented + 2 union types):

Telegram Passport (0/1 methods implemented, 0/13 classes implemented + 1 union type):

Games (0/3 methods implemented, 0/3 classes implemented):

amirrh6 / litegram

Maintainers

Details