Created by Daniil Gentili
#StandWithUkraine 🇺🇦
Do join the official channel, @MadelineProto and the support groups!
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 (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->start();
$me = $MadelineProto->getSelf();
$MadelineProto->logger($me);
if (!$me['bot']) {
$MadelineProto->messages->sendMessage(peer: '@stickeroptimizerbot', message: "/start");
$MadelineProto->channels->joinChannel(channel: '@MadelineProto');
try {
$MadelineProto->messages->importChatInvite(hash: 'https://t.me/+Por5orOjwgccnt2w');
} catch (\danog\MadelineProto\RPCErrorException $e) {
$MadelineProto->logger($e);
}
}
$MadelineProto->echo('OK, done!');Try running 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).
The following open source projects were created using MadelineProto: you can directly install them, or explore the source code as direct examples on how to use MadelineProto's many features!
- TelegramApiServer - Fast, simple, async php telegram api server: an HTTP JSON API for MadelineProto!
downloadRenameBot.php- Download files by URL and rename Telegram files using this async parallelized bot!secret_bot.php- Secret chat bot!pipesbot.php- Creating inline bots and using other inline bots via a userbot!bot.php- Examples for sending normal messages, downloading any media!
Want to add your own open-source project to this list? Click here!
- Creating a client
- Login
- Features
- Requirements
- MadelineProto on Docker
- Installation
- Broadcasting messages to all users
- Handling updates (new messages & other events)
- Database
- Settings
- AppInfo: App information.
- Auth: Cryptography settings.
- Connection: Connection settings.
- Files: File management settings.
- Logger: Logger settings.
- Peer: Peer database settings.
- Pwr: PWRTelegram settings.
- RPC: RPC settings.
- SecretChats: Secret chat settings.
- Serialization: Serialization settings.
- TLSchema: TL schema settings.
- Templates: Web and CLI template settings for login.
- VoIP: VoIP settings.
- Database\Memory: Memory backend settings.
- Database\Mysql: MySQL backend settings.
- Database\Postgres: Postgres backend settings.
- Database\Redis: Redis backend settings.
- Getting info about the current user
- Exceptions
- Avoiding FLOOD_WAITs
- Logging
- Telegram VoIP phone calls
- Uploading and downloading files
- Getting info about chats
- Getting all chats (dialogs)
- Inline buttons
- Secret chats
- Using a proxy
- Async
- FAQ
- Using methods
- Named arguments (PHP 8+)
- Peers
- Files
- Secret chats
- Entities (Markdown & HTML)
- reply_markup (keyboards & inline keyboards)
- bot API objects
- No result
- Queues
- Multiple method calls
- FULL API Documentation with descriptions
- Login
- Change 2FA password: update2FA
- Get all chats, broadcast a message to all chats: getDialogIds, getDialogs, getFullDialogs
- Get the full participant list of a channel/group/supergroup: getPwrChat
- Get full info about a user/chat/supergroup/channel: getFullInfo
- Get info about a user/chat/supergroup/channel: getInfo
- Get the ID of a user/chat/supergroup/channel/update: getID
- Get info about the currently logged-in user: getSelf
- Upload or download files up to 2 GB: uploadFrom*, downloadTo*
- Make a phone call and play a song
- Create a secret chat bot
- Abort a pending 2FA password reset, see here for more info »: account.declinePasswordReset
- Accept QR code login token, logging in the app that generated it: auth.acceptLoginToken
- Accept call: acceptCall
- Accept secret chat: acceptSecretChat
- Accept the new terms of service: help.acceptTermsOfService
- Activate or deactivate a purchased fragment.com username associated to a supergroup or channel we own: channels.toggleUsername
- Activate or deactivate a purchased fragment.com username associated to a bot we own: bots.toggleUsername
- Activate or deactivate a purchased fragment.com username associated to the currently logged-in user: account.toggleUsername
- Add GIF to saved gifs list: messages.saveGif
- Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet
- Add an existing telegram user as contact: contacts.addContact
- Add/remove sticker from recent stickers list: messages.saveRecentSticker
- Adds a user to a chat and sends a service message on it: messages.addChatUser
- Adds the user to the blacklist: contacts.block
- Answer an inline query, for bots only: messages.setInlineBotResults
- Answers a custom query; for bots only: bots.answerWebhookJSONQuery
- Apply changes to multiple stickersets: messages.toggleStickerSets
- Associate a group to a channel as discussion group for that channel: channels.setDiscussionGroup
- Associate a stickerset to the supergroup: channels.setStickers
- Asynchronously lock a file: flock
- Asynchronously read line: readLine
- Asynchronously sleep: sleep
- Asynchronously write to stdout/browser: echo
- Ban/unban/kick a user in a supergroup/channel: channels.editBanned
- Base64URL encode: base64urlEncode
- Can only be used by TSF members to obtain internal information: help.getUserInfo
- Cancel a running broadcast: cancelBroadcast
- Cancel the code that was sent to verify an email to use as 2FA recovery method: account.cancelPasswordEmail
- Cancel the login verification code: auth.cancelCode
- Change authorization settings: account.changeAuthorizationSettings
- Change default emoji reaction to use in the quick reaction menu: the value is synced across devices and can be fetched using help.getConfig, reactions_default field: messages.setDefaultReaction
- Change group call settings: phone.toggleGroupCallSettings
- Change media autodownload settings: account.saveAutoDownloadSettings
- Change or remove the username of a supergroup/channel: channels.updateUsername
- Change privacy settings of current account: account.setPrivacy
- Change the chat theme of a certain chat: messages.setChatTheme
- Change the default peer that should be used when sending messages to a specific group: messages.saveDefaultSendAs
- Change the phone number of the current account: account.changePhone
- Change the photo of a channel/supergroup: channels.editPhoto
- Change the set of message reactions » that can be used in a certain group, supergroup or channel: messages.setChatAvailableReactions
- Changes chat name and sends a service message on it: messages.editChatTitle
- Changes chat photo and sends a service message on it: messages.editChatPhoto
- Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition
- Changes the default value of the Time-To-Live setting, applied to all new chats: messages.setDefaultHistoryTTL
- Changes username for the current user: account.updateUsername
- Check if a certain event handler plugin is installed: hasPluginInstance
- Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername
- Check if an event handler instance is present: hasEventHandler
- Check if has report peers: hasReportPeers
- Check if is array or similar (traversable && countable && arrayAccess): isArrayOrAlike
- Check if peer is present in internal peer database: peerIsset
- Check if the 2FA recovery code sent using auth.requestPasswordRecovery is valid, before passing it to auth.recoverPassword: auth.checkRecoveryPassword
- Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite
- Check whether chat history exported from another chat app can be imported into a specific Telegram chat, click here for more info »: messages.checkHistoryImportPeer
- Check whether provided bot API ID is a channel: isSupergroup
- Check whether secret chat exists: hasSecretChat
- Check whether the given short name is available: stickers.checkShortName
- Check whether the group call Server Forwarding Unit is currently receiving the streams with the specified WebRTC source IDs. : phone.checkGroupCall
- Checks whether Telegram Premium purchase is possible. Must be called before in-store Premium purchase, official apps only: payments.canPurchasePremium
- Clear all drafts: messages.clearAllDrafts
- Clear all peer-specific autosave settings: account.deleteAutoSaveExceptions
- Clear bot commands for the specified bot scope and language code: bots.resetBotCommands
- Clear recent stickers: messages.clearRecentStickers
- Clear recently used message reactions: messages.clearRecentReactions
- Clear saved payment information: payments.clearSavedInfo
- Clears list of recently used emoji statuses: account.clearRecentEmojiStatuses
- Close connection with client, connected via web: closeConnection
- Complet user login using login code: completePhoneLogin
- Complete 2FA login: complete2faLogin
- Complete call handshake: completeCall
- Complete signup to Telegram: completeSignup
- Complete the history import process, importing all messages into the chat. : messages.startHistoryImport
- Confirm a phone number to cancel account deletion, for more info click here »: account.confirmPhone
- Confirm call: confirmCall
- Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages
- Convert MTProto channel ID to bot API channel ID: toSupergroup
- Convert MTProto parameters to bot API parameters: MTProtoToBotAPI
- Convert TD parameters to tdcli: tdToTdcli
- Convert TD to MTProto parameters: tdToMTProto
- Convert a supergroup to a gigagroup, when requested by channel suggestions: channels.convertToGigagroup
- Convert bot API channel ID to MTProto channel ID: fromSupergroup
- Convert bot API parameters to MTProto parameters: botAPIToMTProto
- Convert double to binary version: packDouble
- Convert integer to base256 long: packSignedLong
- Convert integer to base256 signed int: packSignedInt
- Convert tdcli parameters to tdcli: tdcliToTd
- Convert to camelCase: toCamelCase
- Convert to snake_case: toSnakeCase
- Convert value to unsigned base256 int: packUnsignedInt
- Create a forum topic; requires manage_topics rights: channels.createForumTopic
- Create a supergroup/channel: channels.createChannel
- Create a group call or livestream: phone.createGroupCall
- Create a stickerset, bots only: stickers.createStickerSet
- Create a theme: account.createTheme
- Create and upload a new wallpaper: account.uploadWallPaper
- Create array: arr
- Creates a new chat: messages.createChat
- Delete a channel/supergroup: channels.deleteChannel
- Delete a chat: messages.deleteChat
- Delete a chat invite: messages.deleteExportedChatInvite
- Delete a folder imported using a chat folder deep link »: chatlists.leaveChatlist
- Delete a previously created chat folder deep link »: chatlists.deleteExportedInvite
- Delete all installed wallpapers, reverting to the default wallpaper set: account.resetWallPapers
- Delete all messages sent by a specific participant of a given supergroup: channels.deleteParticipantHistory
- Delete all revoked chat invites: messages.deleteRevokedExportedChatInvites
- Delete all temporary authorization keys except for the ones specified: auth.dropTempAuthKeys
- Delete contacts by phone number: contacts.deleteByPhones
- Delete message history of a forum topic: channels.deleteTopicHistory
- Delete messages in a channel/supergroup: channels.deleteMessages
- Delete saved contacts: contacts.resetSaved
- Delete scheduled messages: messages.deleteScheduledMessages
- Delete stored Telegram Passport documents, for more info see the passport docs »: account.deleteSecureValue
- Delete the entire phone call history: messages.deletePhoneCallHistory
- Delete the history of a supergroup: channels.deleteHistory
- Delete the user's account from the telegram servers: account.deleteAccount
- Deletes a device by its token, stops sending PUSH-notifications to it: account.unregisterDevice
- Deletes a stickerset we created, bots only: stickers.deleteStickerSet
- Deletes a user from a chat and sends a service message on it: messages.deleteChatUser
- Deletes communication history: messages.deleteHistory
- Deletes messages by their identifiers: messages.deleteMessages
- Deletes profile photos. The method returns a list of successfully deleted photo IDs: photos.deletePhotos
- Deletes several contacts from the list: contacts.deleteContacts
- Deletes the user from the blacklist: contacts.unblock
- Disable all purchased usernames of a supergroup or channel: channels.deactivateAllUsernames
- Discard call: discardCall
- Discard secret chat: discardSecretChat
- Dismiss a suggestion, see here for more info »: help.dismissSuggestion
- Dismiss new pending peers recently added to a chat folder deep link »: chatlists.hideChatlistUpdates
- Dismiss or approve a chat join request related to a specific chat or channel: messages.hideChatJoinRequest
- Dismiss or approve all join requests related to a specific chat or channel: messages.hideAllChatJoinRequests
- Download file to amphp/http-server response: downloadToResponse
- Download file to browser: downloadToBrowser
- Download file to callable: downloadToCallable
- Download file to directory: downloadToDir
- Download file to stream: downloadToStream
- Download file: downloadToFile
- Edit forum topic; requires manage_topics rights: channels.editForumTopic
- Edit a chat folder deep link »: chatlists.editExportedInvite
- Edit an exported chat invite: messages.editExportedChatInvite
- Edit an inline bot message: messages.editInlineBotMessage
- Edit information about a given group call participant: phone.editGroupCallParticipant
- Edit location of geogroup: channels.editLocation
- Edit message: messages.editMessage
- Edit peers in peer folder: folders.editPeerFolders
- Edit the default banned rights of a channel/supergroup/group: messages.editChatDefaultBannedRights
- Edit the description of a group/supergroup/channel: messages.editChatAbout
- Edit the name of a channel/supergroup: channels.editTitle
- Edit the title of a group call or livestream: phone.editGroupCallTitle
- Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings
- Enable or disable content protection on a channel or chat: messages.toggleNoForwards
- Enable or disable forum functionality in a supergroup: channels.toggleForum
- Enable or disable web bot attachment menu »: messages.toggleBotInAttachMenu
- Enable or disable the native antispam system: channels.toggleAntiSpam
- Enable/disable top peers: contacts.toggleTopPeers
- Enable/disable message signatures in channels: channels.toggleSignatures
- Executes a custom broadcast action with all peers (users, chats, channels) of the bot: broadcastCustom
- Export a folder », creating a chat folder deep link »: chatlists.exportChatlistInvite
- Export an invite link for a chat: messages.exportChatInvite
- Export authorization: exportAuthorization
- Extract Update constructors from an Updates constructor: extractUpdates
- Extract a message ID from an Updates constructor: extractMessageId
- Extract a message constructor from an Updates constructor: extractMessage
- Extract an update message constructor from an Updates constructor: extractMessageUpdate
- Extract file info from bot API message: extractBotAPIFile
- Fetch custom emoji stickers »: messages.getCustomEmojiDocuments
- Fetch new chats associated with an imported chat folder deep link ». Must be invoked at most every chatlist_update_period seconds (as per the related client configuration parameter »): chatlists.getChatlistUpdates
- Fetch saved notification sounds: account.getSavedRingtones
- Find out if a media message's caption can be edited: messages.getMessageEditData
- Finish account takeout session: account.finishTakeoutSession
- Fork a new green thread and execute the passed function in the background: callFork
- Forwards a list of messages to all peers (users, chats, channels) of the bot: broadcastForwardMessages
- Forwards messages by their IDs: messages.forwardMessages
- Generate MTProto vector hash: genVectorHash
- Generate a login token, for login via QR code. : auth.exportLoginToken
- Generate an invoice deep link: payments.exportInvoice
- Generates a temporary profile link for the currently logged-in user: contacts.exportContactToken
- Get MTProxy/Public Service Announcement information: help.getPromoData
- Get PSR logger: getPsrLogger
- Get RTMP URL and stream key for RTMP livestreams. Can be used even before creating the actual RTMP livestream with phone.createGroupCall (the rtmp_stream flag must be set): phone.getGroupCallStreamRtmpUrl
- Get TL namespaces: getMethodNamespaces
- Get TL serializer: getTL
- Get Telegram Premium promotion information: help.getPremiumPromo
- Get Telegram UTF-8 length of string: mbStrlen
- Get channel statistics: stats.getBroadcastStats
- Get channels/supergroups/geogroups we're admin in. Usually called when the user exceeds the limit for owned public channels/supergroups/geogroups, and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels
- Get discussion message from the associated discussion group of a channel to show it on top of the comment section, without actually joining the group: messages.getDiscussionMessage
- Get folders: messages.getDialogFilters
- Get instant view page: messages.getWebPage
- Get message reaction list, along with the sender of each reaction: messages.getMessageReactionsList
- Get message reactions »: messages.getMessagesReactions
- Get message statistics: stats.getMessageStats
- Get passport configuration: help.getPassportConfig
- Get suggested folders: messages.getSuggestedDialogFilters
- Get supergroup statistics: stats.getMegagroupStats
- Get topics of a forum: channels.getForumTopics
- Get a document by its SHA256 hash, mainly used for gifs: messages.getDocumentByHash
- Get a list of channels/supergroups we left: channels.getLeftChannels
- Get a list of default suggested emoji statuses: account.getDefaultEmojiStatuses
- Get a list of peers that can be used to join a group call, presenting yourself as a specific user/channel: phone.getGroupCallJoinAs
- Get a list of sponsored messages: channels.getSponsoredMessages
- Get a message to show to the user when starting the bot: getWebMessage
- Get a payment form: payments.getPaymentForm
- Get a set of suggested custom emoji stickers that can be used as group picture: account.getDefaultGroupPhotoEmojis
- Get a set of suggested custom emoji stickers that can be used as profile picture: account.getDefaultProfilePhotoEmojis
- Get all archived stickers: messages.getArchivedStickers
- Get all available chat themes: account.getChatThemes
- Get all contacts: contacts.getSaved
- Get all groups that can be used as discussion groups: channels.getGroupsForDiscussion
- Get all installed stickers: messages.getAllStickers
- Get all saved Telegram Passport documents, for more info see the passport docs »: account.getAllSecureValues
- Get an invite link for a group call or livestream: phone.exportGroupCallInvite
- Get and increase the view counter of a message sent or forwarded from a channel: messages.getMessagesViews
- Get app-specific configuration, see client configuration for more info on the result: help.getAppConfig
- Get async DNS client: getDNSClient
- Get async HTTP client: getHTTPClient
- Get authorization info: getAuthorization
- Get autosave settings: account.getAutoSaveSettings
- Get cached (or eventually re-fetch) server-side config: getConfig
- Get cached server-side config: getCachedConfig
- Get call info: getCall
- Get call status: callStatus
- Get changed emoji keywords »: messages.getEmojiKeywordsDifference
- Get changelog of current app. : help.getAppChangelog
- Get chats in common with a user: messages.getCommonChats
- Get configuration for CDN file downloads: help.getCdnConfig
- Get contact by telegram IDs: contacts.getContactIDs
- Get contacts near you: contacts.getLocated
- Get contents of remote file asynchronously: fileGetContents
- Get count of online users in a chat: messages.getOnlines
- Get current number of memory-mapped regions, UNIX only: getMaps
- Get current password hint: getHint
- Get days to live of account: account.getAccountTTL
- Get dialog info of specified peers: messages.getPeerDialogs
- Get dialogs manually marked as unread: messages.getDialogUnreadMarks
- Get diffie-hellman configuration: getDhConfig
- Get download info of file: getDownloadInfo
- Get download info of the propic of a user: getPropicInfo
- Get event handler: getEventHandler
- Get extension from file location: getExtensionFromLocation
- Get extension from mime type: getExtensionFromMime
- Get faved stickers: messages.getFavedStickers
- Get featured stickers: messages.getFeaturedStickers
- Get final element of array: end
- Get folder ID from object: getFolderId
- Get forum topics by their ID: channels.getForumTopicsByID
- Get full list of MTProto and API methods: getAllMethods
- Get global privacy settings: account.getGlobalPrivacySettings
- Get group call participants: phone.getGroupParticipants
- Get highscores of a game sent using an inline bot: messages.getInlineGameHighScores
- Get highscores of a game: messages.getGameHighScores
- Get inactive channels and supergroups: channels.getInactiveChannels
- Get info about RTMP streams in a group call or livestream. : phone.getGroupCallStreamChannels
- Get info about a channel/supergroup participant: channels.getParticipant
- Get info about a certain wallpaper: account.getWallPaper
- Get info about a chat invite: messages.getExportedChatInvite
- Get info about a credit card: payments.getBankCardData
- Get info about a group call: phone.getGroupCall
- Get info about a stickerset: messages.getStickerSet
- Get info about an unsupported deep link, see here for more info »: help.getDeepLinkInfo
- Get info about chat invites generated by admins: messages.getAdminsWithInvites
- Get info about file: getFileInfo
- Get info about multiple wallpapers: account.getMultiWallPapers
- Get info about the chat invites of a specific chat: messages.getExportedChatInvites
- Get info about the logged-in user, not cached: fullGetSelf
- Get info about the users that joined the chat using a specific chat invite: messages.getChatInviteImporters
- Get information about a language in a localization pack: langpack.getLanguage
- Get information about all languages in a localization pack: langpack.getLanguages
- Get information about extended media: messages.getExtendedMedia
- Get installed mask stickers: messages.getMaskStickers
- Get installed themes: account.getThemes
- Get link and embed info of a message in a channel/supergroup: channels.exportMessageLink
- Get live location history of a certain user: messages.getRecentLocations
- Get localization pack strings: langpack.getLangPack
- Get localized emoji keywords »: messages.getEmojiKeywords
- Get localized name of the telegram support user: help.getSupportName
- Get localized name, about text and description of a bot (or of the current account, if called by a bot): bots.getBotInfo
- Get logged-in sessions: account.getAuthorizations
- Get logger: getLogger
- Get maximum number of memory-mapped regions, UNIX only: getMaxMaps
- Get media autodownload settings: account.getAutoDownloadSettings
- Get message ranges for saving the user's chat history: messages.getSplitRanges
- Get messages in a reply thread: messages.getReplies
- Get mime type from buffer: getMimeFromBuffer
- Get mime type from file extension: getMimeFromExtension
- Get mime type of file: getMimeFromFile
- Get more info about a Seamless Telegram Login authorization request, for more info click here »: messages.requestUrlAuth
- Get most used peers: contacts.getTopPeers
- Get name, ISO code, localized name and phone codes/patterns of all available countries: help.getCountriesList
- Get namespaced methods (method => namespace): getMethodsNamespaced
- Get new strings in language pack: langpack.getDifference
- Get payment receipt: payments.getPaymentReceipt
- Get peer settings: messages.getPeerSettings
- Get phone call configuration to be passed to libtgvoip's shared config: phone.getCallConfig
- Get pinned dialogs: messages.getPinnedDialogs
- Get poll results for non-anonymous polls: messages.getPollVotes
- Get poll results: messages.getPollResults
- Get preview of webpage: messages.getWebPagePreview
- Get privacy settings of current account: account.getPrivacy
- Get random integer: randomInt
- Get recent stickers: messages.getRecentStickers
- Get recently used emoji statuses: account.getRecentEmojiStatuses
- Get recently used message reactions: messages.getRecentReactions
- Get recently used t.me links: help.getRecentMeUrls
- Get saved GIFs: messages.getSavedGifs
- Get saved Telegram Passport document, for more info see the passport docs »: account.getSecureValue
- Get saved payment information: payments.getSavedInfo
- Get scheduled messages: messages.getScheduledHistory
- Get scheduled messages: messages.getScheduledMessages
- Get secret chat status: secretChatStatus
- Get secret chat: getSecretChat
- Get secure random string of specified length: random
- Get sensitive content settings: account.getContentSettings
- Get sponsored messages for channel: getSponsoredMessages
- Get stickers attached to a photo or video: messages.getAttachedStickers
- Get stickers by emoji: messages.getStickers
- Get strings from a language pack: langpack.getStrings
- Get temporary payment password: account.getTmpPassword
- Get the admin log of a channel/supergroup: channels.getAdminLog
- Get the number of results that would be found by a messages.search call with the same parameters: messages.getSearchCounters
- Get the participants of a supergroup/channel: channels.getParticipants
- Get the progress of a currently running broadcast: getBroadcastProgress
- Get theme information: account.getTheme
- Get type of peer: getType
- Get unread messages where we were mentioned: messages.getUnreadMentions
- Get unread reactions to messages you sent: messages.getUnreadReactions
- Get updates: getUpdates
- Get web login widget authorizations: account.getWebAuthorizations
- Get which users read a specific message: only available for groups and supergroups with less than chat_read_mark_size_threshold members, read receipts will be stored for chat_read_mark_expire_period seconds after the message was sent, see client configuration for more info »: messages.getMessageReadParticipants
- Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings
- Gets featured custom emoji stickersets: messages.getFeaturedEmojiStickers
- Gets the default value of the Time-To-Live setting, applied to all new chats: messages.getDefaultHistoryTTL
- Gets the list of currently installed custom emoji stickersets: messages.getEmojiStickers
- Gets the menu button action for a given user or for all users, previously set using bots.setBotMenuButton; users can see this information in the botInfo constructor: bots.getBotMenuButton
- Got popular message reactions: messages.getTopReactions
- Hide MTProxy/Public Service Announcement information: help.hidePromoData
- Hide or display the participants list in a supergroup: channels.toggleParticipantsHidden
- Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden
- If the peer settings of a new user allow us to add them as contact, add that user as contact: contacts.acceptContact
- If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the bot will receive an updateBotShippingQuery update. Use this method to reply to shipping queries: messages.setBotShippingResults
- Import a chat folder deep link », joining some or all the chats in the folder: chatlists.joinChatlistInvite
- Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite
- Import authorization: importAuthorization
- Import chat history from a foreign chat app into a specific Telegram chat, click here for more info about imported chats »: messages.initHistoryImport
- Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info: contacts.importContacts
- Indicate to the server (from the user side) that the user is still using a web app: messages.prolongWebView
- Inflate stripped photosize to full JPG payload: inflateStripped
- Informs server about a purchase made through the App Store: for official applications only: payments.assignAppStoreTransaction
- Informs server about a purchase made through the Play Store: for official applications only: payments.assignPlayMarketTransaction
- Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus
- Initialize account takeout session: account.initTakeoutSession
- Initialize connection: initConnection
- Initialize self-restart hack: initSelfRestart
- Initiate a 2FA password reset: can only be used if the user is already logged-in, see here for more info »: account.resetPassword
- Initiates QR code login: qrLogin
- Install wallpaper: account.installWallPaper
- Install a stickerset: messages.installStickerSet
- Install a theme: account.installTheme
- Install/uninstall wallpaper: account.saveWallPaper
- Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto
- Internal use: help.editUserInfo
- Invite a set of users to a group call: phone.inviteToGroupCall
- Invite users to a channel/supergroup: channels.inviteToChannel
- Invoke a method within a takeout session: invokeWithTakeout
- Invoke a request without subscribing the used connection for updates (this is enabled by default for file queries): invokeWithoutUpdates
- Invoke the specified query using the specified API layer: invokeWithLayer
- Invoke with the given message range: invokeWithMessagesRange
- Invokes a query after a successful completion of previous queries: invokeAfterMsgs
- Invokes a query after successful completion of one of the previous queries: invokeAfterMsg
- Join a channel/supergroup: channels.joinChannel
- Join a group call: phone.joinGroupCall
- Join channels and supergroups recently added to a chat folder deep link »: chatlists.joinChatlistUpdates
- Leave a channel/supergroup: channels.leaveChannel
- Leave a group call: phone.leaveGroupCall
- List all chat folder deep links » associated to a folder: chatlists.getExportedInvites
- Load channel statistics graph asynchronously: stats.loadAsyncGraph
- Log in to telegram (via CLI or web): start
- Log out an active authorized session by its hash: account.resetAuthorization
- Log out an active web telegram login session: account.resetWebAuthorization
- Logger: logger
- Login as bot: botLogin
- Login as user: phoneLogin
- Login by importing an authorization token: auth.importWebTokenAuthorization
- Login using a redirected login token, generated in case of DC mismatch during QR code login: auth.importLoginToken
- Look for custom emojis associated to a UTF8 emoji: messages.searchCustomEmoji
- Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate
- MTProto to TD params: MTProtoToTd
- MTProto to TDCLI params: MTProtoToTdcli
- Make a user admin in a basic group: messages.editChatAdmin
- Manually mark dialog as unread: messages.markDialogUnread
- Mark channel/supergroup history as read: channels.readHistory
- Mark channel/supergroup message contents as read: channels.readMessageContents
- Mark message reactions » as read: messages.readReactions
- Mark a thread as read: messages.readDiscussion
- Mark a specific sponsored message as read: channels.viewSponsoredMessage
- Mark mentions as read: messages.readMentions
- Mark new featured stickers as read: messages.readFeaturedStickers
- Mark or unmark a sticker as favorite: messages.faveSticker
- Mark sponsored message as read: viewSponsoredMessage
- Marks message history as read: messages.readHistory
- Marks message history within a secret chat as read: messages.readEncryptedHistory
- Method for fetching previously featured stickers: messages.getOldFeaturedStickers
- Modify autosave settings: account.saveAutoSaveSettings
- Modify the admin rights of a user in a supergroup/channel: channels.editAdmin
- Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents
- Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification
- Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change): users.setSecureValueErrors
- Obtain a certain event handler plugin instance: getPluginInstance
- Obtain a list of bot commands for the specified bot scope and language code: bots.getBotCommands
- Obtain a list of related languages that must be used when fetching emoji keyword lists »: messages.getEmojiKeywordsLanguages
- Obtain available message reactions »: messages.getAvailableReactions
- Obtain configuration for two-factor authorization with password: account.getPassword
- Obtain information about a chat folder deep link »: chatlists.checkChatlistInvite
- Obtain information about a named bot web app: messages.getBotApp
- Obtain the API ID UI template: getWebAPITemplate
- Obtain user info from a temporary profile link: contacts.importContactToken
- Obtains a list of messages, indicating to which other public channels was a channel message forwarded. : stats.getMessagePublicForwards
- Obtains a list of peers that can be used to send messages in a specific group: channels.getSendAs
- Obtains information about a chat export file, generated by a foreign chat app, click here for more info about imported chats »: messages.checkHistoryImport
- Once the user has confirmed their payment and shipping details, the bot receives an updateBotPrecheckoutQuery update. : messages.setBotPrecheckoutResults
- Open a bot web app: messages.requestSimpleWebView
- Open a bot web app from a named bot web app deep link, sending over user information after user confirmation: messages.requestAppWebView
- Open a bot web app, sending over user information after user confirmation: messages.requestWebView
- Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall
- Parse, update and store settings: updateSettings
- Pin a message: messages.updatePinnedMessage
- Pin or unpin forum topics: channels.updatePinnedForumTopic
- Pin/unpin a dialog: messages.toggleDialogPin
- Please use the event handler: channels.getMessages
- Please use the event handler: messages.getHistory
- Please use the event handler: messages.getMessages
- Positive modulo: posmod
- Press an inline callback button and get a callback answer from the bot: messages.getBotCallbackAnswer
- Query an inline bot: messages.getInlineBotResults
- Rate transcribed voice message: messages.rateTranscribedAudio
- Rate a call, returns info about the rating message sent to the official VoIP bot: phone.setCallRating
- React to message: messages.sendReaction
- Refresh full peer cache for a certain peer: refreshFullPeerCache
- Refresh peer cache for a certain peer: refreshPeerCache
- Register device to receive PUSH notifications: account.registerDevice
- Rekey secret chat: rekey
- Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet
- Renames a stickerset, bots only: stickers.renameStickerSet
- Reorder folders: messages.updateDialogFiltersOrder
- Reorder active usernames: channels.reorderUsernames
- Reorder installed stickersets: messages.reorderStickerSets
- Reorder pinned dialogs: messages.reorderPinnedDialogs
- Reorder pinned forum topics: channels.reorderPinnedForumTopics
- Reorder usernames associated to a bot we own: bots.reorderUsernames
- Reorder usernames associated with the currently logged-in user: account.reorderUsernames
- Report a message reaction: messages.reportReaction
- Report a native antispam false positive: channels.reportAntiSpamFalsePositive
- Report a message in a chat for violation of telegram's Terms of Service: messages.report
- Report a new incoming chat for spam, if the peer settings of the chat allow us to do that: messages.reportSpam
- Report a peer for violation of telegram's Terms of Service: account.reportPeer
- Report a profile photo of a dialog: account.reportProfilePhoto
- Report a secret chat for spam: messages.reportEncryptedSpam
- Report an error to the previously set peer: report
- Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam
- Represents a list of emoji categories, to be used when selecting custom emojis: messages.getEmojiGroups
- Represents a list of emoji categories, to be used when selecting custom emojis to set as custom emoji status: messages.getEmojiStatusGroups
- Represents a list of emoji categories, to be used when selecting custom emojis to set as profile picture: messages.getEmojiProfilePhotoGroups
- Request VoIP call: requestCall
- Request an SMS code via Firebase: auth.requestFirebaseSms
- Request recovery code of a 2FA password, only for accounts with a recovery email configured: auth.requestPasswordRecovery
- Request secret chat: requestSecretChat
- Resend the code to verify an email to use as 2FA recovery method: account.resendPasswordEmail
- Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see login for more info: auth.resendCode
- Reset rating of top peer: contacts.resetTopPeerRating
- Reset all active web telegram login sessions: account.resetWebAuthorizations
- Reset the 2FA password using the recovery code sent using auth.requestPasswordRecovery: auth.recoverPassword
- Reset the login email »: auth.resetLoginEmail
- Reset the update state and fetch all updates from the beginning: resetUpdateState
- Resets all notification settings from users and groups: account.resetNotifySettings
- Resolve a phone number to get user info, if their privacy settings allow it: contacts.resolvePhone
- Restart update loop: restart
- Rethrow exception into event loop: rethrow
- Return all message drafts. : messages.getAllDrafts
- Return current settings: getSettings
- Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm
- Returns a list of available wallpapers: account.getWallPapers
- Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji keywords ». The URL will be valid for 30 seconds after generation: messages.getEmojiURL
- Returns attachment menu entry for a bot web app that can be launched from the attachment menu »: messages.getAttachMenuBot
- Returns chat basic info on their IDs: messages.getChats
- Returns content of a web file, by proxying the request through telegram, see the webfile docs for more info: upload.getWebFile
- Returns current configuration, including data center configuration: help.getConfig
- Returns found messages: messages.search
- Returns identifiers of pinned or always included chats from a chat folder imported using a chat folder deep link », which are suggested to be left when the chat folder is deleted: chatlists.getLeaveChatlistSuggestions
- Returns info on data center nearest to the user: help.getNearestDc
- Returns information about the next messages of the specified type in the chat split by days: messages.getSearchResultsCalendar
- Returns information on update availability for the current application: help.getAppUpdate
- Returns installed attachment menu bot web apps »: messages.getAttachMenuBots
- Returns list of chats with non-default notification settings: account.getNotifyExceptions
- Returns localized text of a text message with an invitation: help.getInviteText
- Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation: messages.getSearchResultsPositions
- Returns the current user dialog list: messages.getDialogs
- Returns the current user's contact list: contacts.getContacts
- Returns the list of blocked users: contacts.getBlocked
- Returns the list of contact statuses: contacts.getStatuses
- Returns the list of user photos: photos.getUserPhotos
- Returns the session name: getSessionName
- Returns the support user for the "ask a question" feature: help.getSupport
- Returns users found by username substring: contacts.search
- Returns whether the current user is a premium user, cached: isPremium
- Reupload telegram file: uploadFromTgfile
- Save a message draft associated to a chat: messages.saveDraft
- Save a theme: account.saveTheme
- Save or remove saved notification sound: account.saveRingtone
- Save phone call debug information: phone.saveCallLog
- Saves logs of application on the server: help.saveAppLog
- Search for messages and peers globally: messages.searchGlobal
- Search for stickersets: messages.searchStickerSets
- Securely save Telegram Passport document, for more info see the passport docs »: account.saveSecureValue
- Send VoIP signaling data: phone.sendSignalingData
- Send a chosen peer, as requested by a keyboardButtonRequestPeer button: messages.sendBotRequestedPeer
- Send a media: messages.sendMedia
- Send a result obtained using messages.getInlineBotResults: messages.sendInlineBotResult
- Send an album or grouped media: messages.sendMultiMedia
- Send an email verification code: account.sendVerifyEmailCode
- Send compiled payment form: payments.sendPaymentForm
- Send confirmation code to cancel account deletion, for more info click here »: account.sendConfirmPhoneCode
- Send phone call debug data to server: phone.saveCallDebug
- Send scheduled messages right away: messages.sendScheduledMessages
- Send the verification phone code for telegram passport: account.sendVerifyPhoneCode
- Send typing event by the current user to a secret chat: messages.setEncryptedTyping
- Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization
- Sends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group: messages.setTyping
- Sends a custom request; for bots only: bots.sendCustomRequest
- Sends a list of messages to all peers (users, chats, channels) of the bot: broadcastMessages
- Sends a message to a chat: messages.sendMessage
- Sends a message with a file attachment to a secret chat: messages.sendEncryptedFile
- Sends a service message to a secret chat: messages.sendEncryptedService
- Sends a text message to a secret chat: messages.sendEncrypted
- Sends an updateCustomEvent update to the event handler: sendCustomEvent
- Set NOOP update handler, ignoring all updates: setNoop
- Set a custom wallpaper » in a specific private chat with another user: messages.setChatWallPaper
- Set account self-destruction period: account.setAccountTTL
- Set an emoji status: account.updateEmojiStatus
- Set bot command list: bots.setBotCommands
- Set global privacy settings: account.setGlobalPrivacySettings
- Set localized name, about text and description of a bot (or of the current account, if called by a bot): bots.setBotInfo
- Set maximum Time-To-Live of all messages in the specified chat: messages.setHistoryTTL
- Set peer(s) where to send errors occurred in the event loop: setReportPeers
- Set sensitive content settings (for viewing or hiding NSFW content): account.setContentSettings
- Set stickerset thumbnail: stickers.setStickerSetThumb
- Set the API ID UI template: setWebApiTemplate
- Set the callback answer to a user button press (bots only): messages.setBotCallbackAnswer
- Set the default suggested admin rights for bots being added as admins to channels, see here for more info on how to handle them »: bots.setBotBroadcastDefaultAdminRights
- Set the default suggested admin rights for bots being added as admins to groups, see here for more info on how to handle them »: bots.setBotGroupDefaultAdminRights
- Set the default peer that will be used to join a group call in a specific dialog: phone.saveDefaultGroupCallJoinAs
- Set time-to-live of current session: account.setAuthorizationTTL
- Set webhook update handler: setWebhook
- Set whether all users should join a discussion group in order to comment on a post »: channels.toggleJoinToSend
- Set whether all users should request admin approval to join the group »: channels.toggleJoinRequest
- Sets the menu button action » for a given user or for all users: bots.setBotMenuButton
- Setup logger: setupLogger
- Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the peer's settings: messages.hidePeerSettingsBar
- Show or hide the real-time chat translation popup for a certain chat: messages.togglePeerTranslations
- Start a conversation with a bot using a deep linking parameter: messages.startBot
- Start a scheduled group call: phone.startScheduledGroupCall
- Start multiple instances of MadelineProto and the event handlers (enables async): startAndLoopMulti
- Start or stop recording a group call: the recorded audio and video streams will be automatically sent to Saved messages (the chat with ourselves): phone.toggleGroupCallRecord
- Start screen sharing in a call: phone.joinGroupCallPresentation
- Stop getting notifications about thread replies of a certain user in @replies: contacts.blockFromReplies
- Stop screen sharing in a group call: phone.leaveGroupCallPresentation
- Stop update loop: stop
- Store RSA keys for CDN datacenters: getCdnConfig
- Submit requested order information for validation: payments.validateRequestedInfo
- Subscribe or unsubscribe to a scheduled group call: phone.toggleGroupCallStartSubscription
- Subscribe to event handler updates for a channel/supergroup we're not a member of: subscribeToUpdates
- Suggests a short name for a given stickerpack name: stickers.suggestShortName
- Telegram UTF-8 multibyte split: mbStrSplit
- Telegram UTF-8 multibyte substring: mbSubstr
- Terminate a group call: phone.discardGroupCall
- Terminate webview interaction started with messages.requestWebView, sending the specified message to the chat on behalf of the user: messages.sendWebViewResultMessage
- Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations
- Test fibers: testFibers
- Toggle contact sign up notifications: account.setContactSignUpNotification
- Toggle supergroup slow mode: if enabled, users will only be able to send one message every seconds seconds: channels.toggleSlowMode
- Transfer channel ownership: channels.editCreator
- Translate a given text: messages.translateText
- Turn a basic group into a supergroup: messages.migrateChat
- Uninstall a stickerset: messages.uninstallStickerSet
- Unpack base256 signed int: unpackSignedInt
- Unpack base256 signed long to string: unpackSignedLongString
- Unpack base256 signed long: unpackSignedLong
- Unpack binary double: unpackDouble
- Unpack bot API file ID: unpackFileId
- Unset event handler: unsetEventHandler
- Update folder: messages.updateDialogFilter
- Update the keywords, emojis or mask coordinates of a sticker, bots only: stickers.changeSticker
- Update theme: account.updateTheme
- Updates current user profile photo: photos.uploadProfilePhoto
- Updates online user status: account.updateStatus
- Updates user profile: account.updateProfile
- Upload a custom profile picture for a contact, or suggest a new profile picture to a contact: photos.uploadContactProfilePhoto
- Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia
- Upload a media file associated with an imported chat, click here for more info »: messages.uploadImportedMedia
- Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile
- Upload file from URL: uploadFromUrl
- Upload file from callable: uploadFromCallable
- Upload file from stream: uploadFromStream
- Upload file to secret chat: uploadEncrypted
- Upload file: upload
- Upload notification sound, use account.saveRingtone to convert it and add it to the list of saved notification sounds: account.uploadRingtone
- Upload theme: account.uploadTheme
- Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore
- Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore
- Use this to accept a Seamless Telegram Login authorization request, for more info click here »: messages.acceptUrlAuth
- Used by the user to relay data from an opened reply keyboard bot web app to the bot that owns it: messages.sendWebViewData
- Validates a username and checks availability: account.checkUsername
- Verify a new phone number to associate to the current account: account.sendChangePhoneCode
- Verify a phone number for telegram passport: account.verifyPhone
- Verify an email address: account.verifyEmail
- Verify an email to use as 2FA recovery method: account.confirmPasswordEmail
- View and search recently sent media. : messages.searchSentMedia
- Vote in a poll: messages.sendVote
- When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications: account.updateDeviceLocked
- When were full info for this chat last cached: fullChatLastUpdated
- Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification
- Whether this is altervista: isAltervista
- Whether we're an IPC client instance: isIpc
- Whether we're an IPC server process (as opposed to an event handler): isIpcWorker
- Transcribe voice message: messages.transcribeAudio
- Unpin all pinned messages: messages.unpinAllMessages
- base64URL decode: base64urlDecode
- null-byte RLE decode: rleDecode
- null-byte RLE encode: rleEncode
- Contributing
- Web templates for
$MadelineProto->start()