MadelineProto, a PHP MTProto telegram client

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

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!).

Getting started

<?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->start();

$me = $MadelineProto->get_self();

\danog\MadelineProto\Logger::log($me);

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

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

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

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

• Creating a client
• Logging in
  • Automatic
  • Manual (user)
  • Manual (bot)
  • Logout
• Features
• Requirements
• Installation
  • Simple
  • Simple (manual)
  • Composer from scratch
  • Composer from existing project
• Handling updates
  • Event driven
    • Event driven multithreaded
  • Multi-account: Combined Event driven update handling
  • Webhook
    • Webhook multithreaded
  • Long polling (getupdates)
  • Callback
    • Callback multithreaded
  • Noop
• Settings
• Getting info about the current user
• Exceptions
  • List of exception types
  • Pretty TL trace
  • Getting the TL trace
• Avoiding FLOOD_WAITs
• Logging
• Using methods
  • FULL API Documentation with descriptions
  • Peers
  • Files
  • Secret chats
  • Entities (Markdown & HTML)
  • reply_markup (keyboards & inline keyboards)
  • bot API objects
  • No result
  • Queues
• 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
    • 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)
• Getting all chats (dialogs)
  • As user
  • As bot
• Inline buttons
• Calls
  • Requesting a call
    • Playing mp3 files
    • Playing streams
    • Changing audio quality
  • Putting it all together
  • Accepting calls
• Secret chats
  • Requesting secret chats
  • Accepting secret chats
  • Checking secret chat status
  • Sending secret messages
• Lua binding
• Using a proxy
  • Use pre-built Socks5 proxy
  • Use pre-built HTTP proxy
  • Build your own proxy
• 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