MadelineProto, a PHP MTProto telegram client

Created by Daniil Gentili

Do join the official channel, @MadelineProto and the support groups!

Approved by Telegram!

What's this?

This library can be used to easily interact with Telegram without the bot API, just like the official apps.

It can login with a phone number (MTProto API), or with a bot token (MTProto API, no bot API involved!).

It is now fully async!

Getting started (now fully async!)

<?php

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->async(true);
$MadelineProto->loop(function () use ($MadelineProto) {
    yield $MadelineProto->start();

    $me = yield $MadelineProto->get_self();

    $MadelineProto->logger($me);

    if (!$me['bot']) {
        yield $MadelineProto->messages->sendMessage(['peer' => '@danogentili', 'message' => "Hi!\nThanks for creating MadelineProto! <3"]);
        yield $MadelineProto->channels->joinChannel(['channel' => '@MadelineProto']);

        try {
            yield $MadelineProto->messages->importChatInvite(['hash' => 'https://t.me/joinchat/Bgrajz6K-aJKu0IpGsLpBg']);
        } catch (\danog\MadelineProto\RPCErrorException $e) {
            $MadelineProto->logger($e);
        }

        yield $MadelineProto->messages->sendMessage(['peer' => 'https://t.me/joinchat/Bgrajz6K-aJKu0IpGsLpBg', 'message' => 'Testing MadelineProto!']);
    }
    yield $MadelineProto->echo('OK, done!');
});

Try this code now! or run this code in a browser or in a console.

Tip: if you receive an error (or nothing), send us the error message and the MadelineProto.log file that was created in the same directory (if running from a browser).

Documentation

• Async
  • Usage
    • Enabling the MadelineProto async API
    • Using the MadelineProto async API
      • Async in event handler
      • Async in callback handler
      • Wrapped async
      • Multiple async
      • ArrayAccess async
      • Ignored async
      • Blocking async
    • MadelineProto and AMPHP async APIs
      • Helper methods
        • Async sleep
        • Async readline
        • Async echo
        • MadelineProto artax HTTP client
        • Async forking
        • Async flock
        • Combining async operations
      • MadelineProto async loop APIs
        • Loop
        • ResumableLoop
        • SignalLoop
        • ResumableSignalLoop
        • GenericLoop
• Creating a client
• Login
  • Getting permission to use the telegram API
  • Automatic
  • Manual (user)
    • API ID
  • Manual (bot)
  • Logout
  • Changing 2FA password
• Features
• Requirements
• Installation
  • Simple
  • Simple (manual)
  • Composer from scratch
  • Composer from existing project
• Handling updates (new messages)
  • Self-restart on webhosts
  • Async Event driven
  • Multi-account: Async Combined Event driven update handling
  • Async Callback
  • Noop (default)
  • Fetch all updates from the beginning
• Settings
• Getting info about the current user
• Exceptions
  • List of exception types
  • Pretty TL trace
  • Getting the TL trace
• Avoiding FLOOD_WAITs
• Logging
• Telegram VoIP phone calls
  • Requesting a call
    • Playing mp3 files
    • Playing streams
    • Changing audio quality
  • Putting it all together
  • Accepting calls
• Uploading and downloading files
  • Uploading & sending files
    • Security notice
    • Photos
    • Documents
      • Documents
      • Photos as documents
      • GIFs
      • Videos
      • Audio & Voice
  • Uploading files
  • Bot API file IDs
  • Reusing uploaded files
  • Downloading files
    • Extracting download info
    • Downloading profile pictures
    • Download to directory
    • Download to file
    • Download to browser (streaming)
  • Getting progress
• Getting info about chats
  • Full chat info with full list of participants
  • Full chat info
  • Reduced chat info (very fast)
  • Just the chat ID (extremely fast)
• Getting all chats (dialogs)
  • Dialog list
  • Full dialog info
• [Inline buttons (now fully async!)](https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html)
• Secret chats
  • Requesting secret chats
  • Accepting secret chats
  • Checking secret chat status
  • Sending secret messages
• Lua binding
• Using a proxy
  • How to set a proxy
  • Multiple proxies with automatic switch
  • Use pre-built MTProxy
  • Use pre-built Socks5 proxy
  • Use pre-built HTTP proxy
  • Build your own proxy
• Using methods
  • FULL API Documentation with descriptions
    • Logout
    • Login
    • Change 2FA password
    • Get all chats, broadcast a message to all chats
    • Get the full participant list of a channel/group/supergroup
    • Get full info about a user/chat/supergroup/channel
    • Get info about a user/chat/supergroup/channel
    • Get info about the currently logged-in user
    • Upload or download files up to 1.5 GB
    • Make a phone call and play a song
    • Create a secret chat bot
  • Peers
  • Files
  • Secret chats
  • Entities (Markdown & HTML)
  • reply_markup (keyboards & inline keyboards)
  • bot API objects
  • No result
  • Queues
  • Multiple method calls
• Contributing
  • Translation
  • Contribution guide
  • Credits
• Web templates for $MadelineProto->start()

Very complex and complete examples

You can find examples for nearly every MadelineProto function in

• tests/testing.php - examples for making/receiving calls, making secret chats, sending secret chat messages, videos, audios, voice recordings, gifs, stickers, photos, sending normal messages, videos, audios, voice recordings, gifs, stickers, photos.
• bot.php - examples for sending normal messages, downloading any media
• secret_bot.php - secret chat bot
• multiprocess_bot.php - multithreaded bot
• magna.php - examples for receiving calls
• userbots/pipesbot.php - examples for creating inline bots and using other inline bots via a userbot
• userbots/MadelineProto_bot.php - Multi-function bot
• userbots/pwrtelegram_debug_bot - Multi-function bot