2017-08-20 17:37:29 +02:00
# MadelineProto, a PHP MTProto telegram client
2015-03-11 16:42:20 +01:00
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
Do join the official channel, [@MadelineProto ](https://t.me/MadelineProto ) and the [support groups ](https://t.me/pwrtelegramgroup )!
2017-08-28 11:38:44 +02:00
2017-08-20 18:04:54 +02:00
2018-03-12 22:10:49 +01:00
## What's this?
2017-08-20 18:04:54 +02:00
2018-03-14 12:08:10 +01:00
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!** ).
2016-08-14 21:38:32 +02:00
2018-03-12 22:10:49 +01:00
## Getting started
2017-03-11 19:54:51 +01:00
2018-03-20 13:04:44 +01:00
```php
2018-03-12 22:10:49 +01:00
< ?php
2017-02-05 15:15:48 +01:00
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
2018-03-12 22:10:49 +01:00
include 'madeline.php';
2017-12-21 10:52:23 +01:00
2018-03-12 22:10:49 +01:00
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
2017-02-05 15:15:48 +01:00
2018-03-12 22:27:10 +01:00
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
$MadelineProto->start();
2017-02-05 15:15:48 +01:00
2018-03-12 22:10:49 +01:00
$MadelineProto->messages->sendMessage(['peer' => '@danogentili', 'message' => "Hi!\nThanks for creating MadelineProto! < 3 "]);
$MadelineProto->channels->joinChannel(['channel' => '@MadelineProto']);
2017-10-04 14:43:51 +02:00
```
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
Run this code in a browser or in a console.
2018-03-12 22:10:49 +01:00
## Documentation
2017-10-04 14:43:51 +02:00
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
* [Creating a client ](https://docs.madelineproto.xyz/docs/CREATING_A_CLIENT.html )
* [Logging in ](https://docs.madelineproto.xyz/docs/LOGIN.html )
* [Automatic ](https://docs.madelineproto.xyz/docs/LOGIN.html#automatic )
* [Manual (user) ](https://docs.madelineproto.xyz/docs/LOGIN.html#manual-user )
* [Manual (bot) ](https://docs.madelineproto.xyz/docs/LOGIN.html#manual-bot )
* [Logout ](https://docs.madelineproto.xyz/docs/LOGIN.html#logout )
* [Features ](https://docs.madelineproto.xyz/docs/FEATURES.html )
* [Requirements ](https://docs.madelineproto.xyz/docs/REQUIREMENTS.html )
* [Installation ](https://docs.madelineproto.xyz/docs/INSTALLATION.html )
* [Simple ](https://docs.madelineproto.xyz/docs/INSTALLATION.html#simple )
* [Simple (manual) ](https://docs.madelineproto.xyz/docs/INSTALLATION.html#simple-manual )
* [Composer from scratch ](https://docs.madelineproto.xyz/docs/INSTALLATION.html#composer-from-scratch )
* [Composer from existing project ](https://docs.madelineproto.xyz/docs/INSTALLATION.html#composer-from-existing-project )
* [Git ](https://docs.madelineproto.xyz/docs/INSTALLATION.html#git )
* [Handling updates ](https://docs.madelineproto.xyz/docs/UPDATES.html )
2018-03-20 13:04:44 +01:00
* [Event driven ](https://docs.madelineproto.xyz/docs/UPDATES.html#event-driven )
* [Event driven multithreaded ](https://docs.madelineproto.xyz/docs/UPDATES.html#event-driven-multithreaded )
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
* [Webhook ](https://docs.madelineproto.xyz/docs/UPDATES.html#webhook )
2018-03-20 13:04:44 +01:00
* [Webhook multithreaded ](https://docs.madelineproto.xyz/docs/UPDATES.html#webhook-multithreaded )
* [Long polling (getupdates) ](https://docs.madelineproto.xyz/docs/UPDATES.html#long-polling )
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
* [Callback ](https://docs.madelineproto.xyz/docs/UPDATES.html#callback )
2018-03-20 13:04:44 +01:00
* [Callback multithreaded ](https://docs.madelineproto.xyz/docs/UPDATES.html#callback-multithreaded )
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
* [Settings ](https://docs.madelineproto.xyz/docs/SETTINGS.html )
* [Getting info about the current user ](https://docs.madelineproto.xyz/docs/SELF.html )
* [Exceptions ](https://docs.madelineproto.xyz/docs/EXCEPTIONS.html )
* [List of exception types ](https://docs.madelineproto.xyz/docs/EXCEPTIONS.html#list-of-exception-types )
* [Pretty TL trace ](https://docs.madelineproto.xyz/docs/EXCEPTIONS.html#pretty-tl-trace )
* [Getting the TL trace ](https://docs.madelineproto.xyz/docs/EXCEPTIONS.html#getting-the-tl-trace )
* [Logging ](https://docs.madelineproto.xyz/docs/LOGGING.html )
* [Using methods ](https://docs.madelineproto.xyz/docs/USING_METHODS.html )
* [Peers ](https://docs.madelineproto.xyz/docs/USING_METHODS.html#peers )
* [Secret chats ](https://docs.madelineproto.xyz/docs/USING_METHODS.html#secret-chats )
* [Entities (Markdown & HTML) ](https://docs.madelineproto.xyz/docs/USING_METHODS.html#entities )
* [reply_markup (keyboards & inline keyboards) ](https://docs.madelineproto.xyz/docs/USING_METHODS.html#reply_markup )
* [bot API objects ](https://docs.madelineproto.xyz/docs/USING_METHODS.html#bot-api-objects )
* [No result ](https://docs.madelineproto.xyz/docs/USING_METHODS.html#no-result )
* [Queues ](https://docs.madelineproto.xyz/docs/USING_METHODS.html#queues )
* [Uploading and downloading files ](https://docs.madelineproto.xyz/docs/FILES.html )
* [Uploading & sending files ](https://docs.madelineproto.xyz/docs/FILES.html#sending-files )
* [Security notice ](https://docs.madelineproto.xyz/docs/FILES.html#security-notice )
* [Photos ](https://docs.madelineproto.xyz/docs/FILES.html#inputmediauploadedphoto )
* [Documents ](https://docs.madelineproto.xyz/docs/FILES.html#inputmediauploadeddocument )
* [Documents ](https://docs.madelineproto.xyz/docs/FILES.html#documentattributefilename-to-send-a-document )
* [Photos as documents ](https://docs.madelineproto.xyz/docs/FILES.html#documentattributeimagesize-to-send-a-photo-as-document )
* [GIFs ](https://docs.madelineproto.xyz/docs/FILES.html#documentattributeanimated-to-send-a-gif )
* [Videos ](https://docs.madelineproto.xyz/docs/FILES.html#documentattributevideo-to-send-a-video )
* [Audio & Voice ](https://docs.madelineproto.xyz/docs/FILES.html#documentattributeaudio-to-send-an-audio-file )
* [Uploading files ](https://docs.madelineproto.xyz/docs/FILES.html#uploading-files )
* [Bot API file IDs ](https://docs.madelineproto.xyz/docs/FILES.html#bot-api-file-ids )
* [Reusing uploaded files ](https://docs.madelineproto.xyz/docs/FILES.html#reusing-uploaded-files )
* [Downloading files ](https://docs.madelineproto.xyz/docs/FILES.html#downloading-files )
* [Extracting download info ](https://docs.madelineproto.xyz/docs/FILES.html#extracting-download-info )
* [Download to directory ](https://docs.madelineproto.xyz/docs/FILES.html#download-to-directory )
* [Download to file ](https://docs.madelineproto.xyz/docs/FILES.html#download-to-file )
* [Download to browser (streaming) ](https://docs.madelineproto.xyz/docs/FILES.html#download-to-browser-with-streams )
* [Getting progress ](https://docs.madelineproto.xyz/docs/FILES.html#getting-progress )
* [Getting info about chats ](https://docs.madelineproto.xyz/docs/CHAT_INFO.html )
* [Full chat info with full list of participants ](https://docs.madelineproto.xyz/docs/CHAT_INFO.html#get_pwr_chat )
* [Full chat info ](https://docs.madelineproto.xyz/docs/CHAT_INFO.html#get_full_info )
* [Reduced chat info (very fast) ](https://docs.madelineproto.xyz/docs/CHAT_INFO.html#get_info )
* [Getting all chats ](https://docs.madelineproto.xyz/docs/DIALOGS.html )
* [As user ](https://docs.madelineproto.xyz/docs/DIALOGS.html#user-get_dialogs )
* [As bot ](https://docs.madelineproto.xyz/docs/DIALOGS.html#bot-internal-peer-database )
* [Inline buttons ](https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html )
* [Calls ](https://docs.madelineproto.xyz/docs/CALLS.html )
* [Requesting a call ](https://docs.madelineproto.xyz/docs/CALLS.html#requesting-a-call )
* [Playing mp3 files ](https://docs.madelineproto.xyz/docs/CALLS.html#playing-mp3-files )
* [Playing streams ](https://docs.madelineproto.xyz/docs/CALLS.html#playing-streams )
* [Changing audio quality ](https://docs.madelineproto.xyz/docs/CALLS.html#changing-audio-quality )
* [Putting it all together ](https://docs.madelineproto.xyz/docs/CALLS.html#putting-it-all-together )
* [Accepting calls ](https://docs.madelineproto.xyz/docs/CALLS.html#accepting-calls )
* [Secret chats ](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html )
* [Requesting secret chats ](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#requesting-secret-chats )
* [Accepting secret chats ](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#accepting-secret-chats )
* [Checking secret chat status ](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#checking-secret-chat-status )
* [Sending secret messages ](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#sending-secret-messages )
* [Lua binding ](https://docs.madelineproto.xyz/docs/LUA.html )
* [Using a proxy ](https://docs.madelineproto.xyz/docs/PROXY.html )
2017-10-04 14:43:51 +02:00
2017-08-18 13:27:44 +02:00
2018-03-12 22:10:49 +01:00
## Very complex and complete examples
2017-08-18 13:27:44 +02:00
You can find examples for nearly every MadelineProto function in
* [`tests/testing.php` ](https://github.com/danog/MadelineProto/blob/master/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` ](https://github.com/danog/MadelineProto/blob/master/bot.php ) - examples for sending normal messages, downloading any media
2018-03-12 22:10:49 +01:00
* [`secret_bot.php` ](https://github.com/danog/MadelineProto/blob/master/secret_bot.php ) - secret chat bot
* [`multiprocess_bot.php` ](https://github.com/danog/MadelineProto/blob/master/multiprocess_bot.php ) - multithreaded bot
2017-08-18 13:27:44 +02:00
* [`magna.php` ](https://github.com/danog/MadelineProto/blob/master/magna.php ) - examples for receiving calls
2017-09-26 15:08:25 +02:00
* [`userbots/pipesbot.php` ](https://github.com/danog/MadelineProto/blob/master/userbots/pipesbot.php ) - examples for creating inline bots and using other inline bots via a userbot
2018-03-12 22:10:49 +01:00
* [`userbots/MadelineProto_bot.php` ](https://github.com/danog/MadelineProto/blob/master/userbots/MadelineProto_bot.php ) - Multi-function bot
* [`userbots/pwrtelegram_debug_bot` ](https://github.com/danog/MadelineProto/blob/master/userbots/pwrtelegram_debug_bot.php ) - Multi-function bot
2016-10-07 00:36:18 +02:00
2015-03-11 17:52:28 +01:00