MadelineProto/docs/API_docs/methods/index.md

Methods

$MadelineProto->[account->changePhone](account.changePhone.md)(\['phone\_number' => [string](../types/string.md), 'phone\_code\_hash' => [string](../types/string.md), 'phone\_code' => [string](../types/string.md), \]) == [$User](../types/User.md);

$MadelineProto->account->checkUsername(['username' => string, ]) == $Bool;

$MadelineProto->account->confirmPhone(['phone_code_hash' => string, 'phone_code' => string, ]) == $Bool;

$MadelineProto->account->deleteAccount(['reason' => string, ]) == $Bool;

$MadelineProto->account->getAccountTTL() == $AccountDaysTTL;

$MadelineProto->account->getAuthorizations() == $account_Authorizations;

$MadelineProto->account->getNotifySettings(['peer' => InputNotifyPeer, ]) == $PeerNotifySettings;

$MadelineProto->account->getPassword() == $account_Password;

$MadelineProto->account->getPasswordSettings(['current_password_hash' => bytes, ]) == $account_PasswordSettings;

$MadelineProto->account->getPrivacy(['key' => InputPrivacyKey, ]) == $account_PrivacyRules;

$MadelineProto->account->getWallPapers() == $Vector_of_WallPaper;

$MadelineProto->account->registerDevice(['token_type' => int, 'token' => string, ]) == $Bool;

$MadelineProto->account->reportPeer(['peer' => InputPeer, 'reason' => ReportReason, ]) == $Bool;

$MadelineProto->account->resetAuthorization(['hash' => long, ]) == $Bool;

$MadelineProto->account->resetNotifySettings() == $Bool;

$MadelineProto->account->sendChangePhoneCode(['allow_flashcall' => Bool, 'phone_number' => string, 'current_number' => Bool, ]) == $auth_SentCode;

$MadelineProto->account->sendConfirmPhoneCode(['allow_flashcall' => Bool, 'hash' => string, 'current_number' => Bool, ]) == $auth_SentCode;

$MadelineProto->account->setAccountTTL(['ttl' => AccountDaysTTL, ]) == $Bool;

$MadelineProto->account->setPrivacy(['key' => InputPrivacyKey, 'rules' => [InputPrivacyRule], ]) == $account_PrivacyRules;

$MadelineProto->account->unregisterDevice(['token_type' => int, 'token' => string, ]) == $Bool;

$MadelineProto->account->updateDeviceLocked(['period' => int, ]) == $Bool;

$MadelineProto->account->updateNotifySettings(['peer' => InputNotifyPeer, 'settings' => InputPeerNotifySettings, ]) == $Bool;

$MadelineProto->account->updatePasswordSettings(['current_password_hash' => bytes, 'new_settings' => account_PasswordInputSettings, ]) == $Bool;

$MadelineProto->account->updateProfile(['first_name' => string, 'last_name' => string, 'about' => string, ]) == $User;

$MadelineProto->account->updateStatus(['offline' => Bool, ]) == $Bool;

$MadelineProto->account->updateUsername(['username' => string, ]) == $User;

$MadelineProto->auth->bindTempAuthKey(['perm_auth_key_id' => long, 'nonce' => long, 'expires_at' => int, 'encrypted_message' => bytes, ]) == $Bool;

$MadelineProto->auth->cancelCode(['phone_number' => string, 'phone_code_hash' => string, ]) == $Bool;

$MadelineProto->auth->checkPassword(['password_hash' => bytes, ]) == $auth_Authorization;

$MadelineProto->auth->checkPhone(['phone_number' => string, ]) == $auth_CheckedPhone;

$MadelineProto->auth->dropTempAuthKeys(['except_auth_keys' => [long], ]) == $Bool;

$MadelineProto->auth->exportAuthorization(['dc_id' => int, ]) == $auth_ExportedAuthorization;

$MadelineProto->auth->importAuthorization(['id' => int, 'bytes' => bytes, ]) == $auth_Authorization;

$MadelineProto->auth->importBotAuthorization(['api_id' => int, 'api_hash' => string, 'bot_auth_token' => string, ]) == $auth_Authorization;

$MadelineProto->auth->logOut() == $Bool;

$MadelineProto->auth->recoverPassword(['code' => string, ]) == $auth_Authorization;

$MadelineProto->auth->requestPasswordRecovery() == $auth_PasswordRecovery;

$MadelineProto->auth->resendCode(['phone_number' => string, 'phone_code_hash' => string, ]) == $auth_SentCode;

$MadelineProto->auth->resetAuthorizations() == $Bool;

$MadelineProto->auth->sendCode(['allow_flashcall' => Bool, 'phone_number' => string, 'current_number' => Bool, 'api_id' => int, 'api_hash' => string, ]) == $auth_SentCode;

$MadelineProto->auth->sendInvites(['phone_numbers' => [string], 'message' => string, ]) == $Bool;

$MadelineProto->auth->signIn(['phone_number' => string, 'phone_code_hash' => string, 'phone_code' => string, ]) == $auth_Authorization;

$MadelineProto->auth->signUp(['phone_number' => string, 'phone_code_hash' => string, 'phone_code' => string, 'first_name' => string, 'last_name' => string, ]) == $auth_Authorization;

$MadelineProto->channels->checkUsername(['channel' => InputChannel, 'username' => string, ]) == $Bool;

$MadelineProto->channels->createChannel(['broadcast' => Bool, 'megagroup' => Bool, 'title' => string, 'about' => string, ]) == $Updates;

$MadelineProto->channels->deleteChannel(['channel' => InputChannel, ]) == $Updates;

$MadelineProto->channels->deleteMessages(['channel' => InputChannel, 'id' => [int], ]) == $messages_AffectedMessages;

$MadelineProto->channels->deleteUserHistory(['channel' => InputChannel, 'user_id' => InputUser, ]) == $messages_AffectedHistory;

$MadelineProto->channels->editAbout(['channel' => InputChannel, 'about' => string, ]) == $Bool;

$MadelineProto->channels->editAdmin(['channel' => InputChannel, 'user_id' => InputUser, 'role' => ChannelParticipantRole, ]) == $Updates;

$MadelineProto->channels->editPhoto(['channel' => InputChannel, 'photo' => InputChatPhoto, ]) == $Updates;

$MadelineProto->channels->editTitle(['channel' => InputChannel, 'title' => string, ]) == $Updates;

$MadelineProto->channels->exportInvite(['channel' => InputChannel, ]) == $ExportedChatInvite;

$MadelineProto->channels->exportMessageLink(['channel' => InputChannel, 'id' => int, ]) == $ExportedMessageLink;

$MadelineProto->channels->getAdminedPublicChannels() == $messages_Chats;

$MadelineProto->channels->getChannels(['id' => [InputChannel], ]) == $messages_Chats;

$MadelineProto->channels->getFullChannel(['channel' => InputChannel, ]) == $messages_ChatFull;

$MadelineProto->channels->getMessages(['channel' => InputChannel, 'id' => [int], ]) == $messages_Messages;

$MadelineProto->channels->getParticipant(['channel' => InputChannel, 'user_id' => InputUser, ]) == $channels_ChannelParticipant;

$MadelineProto->channels->getParticipants(['channel' => InputChannel, 'filter' => ChannelParticipantsFilter, 'offset' => int, 'limit' => int, ]) == $channels_ChannelParticipants;

$MadelineProto->channels->inviteToChannel(['channel' => InputChannel, 'users' => [InputUser], ]) == $Updates;

$MadelineProto->channels->joinChannel(['channel' => InputChannel, ]) == $Updates;

$MadelineProto->channels->kickFromChannel(['channel' => InputChannel, 'user_id' => InputUser, 'kicked' => Bool, ]) == $Updates;

$MadelineProto->channels->leaveChannel(['channel' => InputChannel, ]) == $Updates;

$MadelineProto->channels->readHistory(['channel' => InputChannel, 'max_id' => int, ]) == $Bool;

$MadelineProto->channels->reportSpam(['channel' => InputChannel, 'user_id' => InputUser, 'id' => [int], ]) == $Bool;

$MadelineProto->channels->toggleInvites(['channel' => InputChannel, 'enabled' => Bool, ]) == $Updates;

$MadelineProto->channels->toggleSignatures(['channel' => InputChannel, 'enabled' => Bool, ]) == $Updates;

$MadelineProto->channels->updatePinnedMessage(['silent' => Bool, 'channel' => InputChannel, 'id' => int, ]) == $Updates;

$MadelineProto->channels->updateUsername(['channel' => InputChannel, 'username' => string, ]) == $Bool;

$MadelineProto->contacts->block(['id' => InputUser, ]) == $Bool;

$MadelineProto->contacts->deleteContact(['id' => InputUser, ]) == $contacts_Link;

$MadelineProto->contacts->deleteContacts(['id' => [InputUser], ]) == $Bool;

$MadelineProto->contacts->exportCard() == $Vector_of_int;

$MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]) == $contacts_Blocked;

$MadelineProto->contacts->getContacts(['hash' => string, ]) == $contacts_Contacts;

$MadelineProto->contacts->getStatuses() == $Vector_of_ContactStatus;

$MadelineProto->contacts->getTopPeers(['correspondents' => Bool, 'bots_pm' => Bool, 'bots_inline' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => int, ]) == $contacts_TopPeers;

$MadelineProto->contacts->importCard(['export_card' => [int], ]) == $User;

$MadelineProto->contacts->importContacts(['contacts' => [InputContact], 'replace' => Bool, ]) == $contacts_ImportedContacts;

$MadelineProto->contacts->resetTopPeerRating(['category' => TopPeerCategory, 'peer' => InputPeer, ]) == $Bool;

$MadelineProto->contacts->resolveUsername(['username' => string, ]) == $contacts_ResolvedPeer;

$MadelineProto->contacts->search(['q' => string, 'limit' => int, ]) == $contacts_Found;

$MadelineProto->contacts->unblock(['id' => InputUser, ]) == $Bool;

$MadelineProto->help->getAppChangelog() == $help_AppChangelog;

$MadelineProto->help->getAppUpdate() == $help_AppUpdate;

$MadelineProto->help->getConfig() == $Config;

$MadelineProto->help->getInviteText() == $help_InviteText;

$MadelineProto->help->getNearestDc() == $NearestDc;

$MadelineProto->help->getSupport() == $help_Support;

$MadelineProto->help->getTermsOfService() == $help_TermsOfService;

$MadelineProto->help->saveAppLog(['events' => [InputAppEvent], ]) == $Bool;

$MadelineProto->initConnection(['api_id' => int, 'device_model' => string, 'system_version' => string, 'app_version' => string, 'lang_code' => string, 'query' => !X, ]) == $X;

$MadelineProto->invokeAfterMsg(['msg_id' => long, 'query' => !X, ]) == $X;

$MadelineProto->invokeAfterMsgs(['msg_ids' => [long], 'query' => !X, ]) == $X;

$MadelineProto->invokeWithLayer(['layer' => int, 'query' => !X, ]) == $X;

$MadelineProto->invokeWithoutUpdates(['query' => !X, ]) == $X;

$MadelineProto->messages->acceptEncryption(['peer' => InputEncryptedChat, 'g_b' => bytes, 'key_fingerprint' => long, ]) == $EncryptedChat;

$MadelineProto->messages->addChatUser(['chat_id' => int, 'user_id' => InputUser, 'fwd_limit' => int, ]) == $Updates;

$MadelineProto->messages->checkChatInvite(['hash' => string, ]) == $ChatInvite;

$MadelineProto->messages->clearRecentStickers(['attached' => Bool, ]) == $Bool;

$MadelineProto->messages->createChat(['users' => [InputUser], 'title' => string, ]) == $Updates;

$MadelineProto->messages->deleteChatUser(['chat_id' => int, 'user_id' => InputUser, ]) == $Updates;

$MadelineProto->messages->deleteHistory(['just_clear' => Bool, 'peer' => InputPeer, 'max_id' => int, ]) == $messages_AffectedHistory;

$MadelineProto->messages->deleteMessages(['id' => [int], ]) == $messages_AffectedMessages;

$MadelineProto->messages->discardEncryption(['chat_id' => int, ]) == $Bool;

$MadelineProto->messages->editChatAdmin(['chat_id' => int, 'user_id' => InputUser, 'is_admin' => Bool, ]) == $Bool;

$MadelineProto->messages->editChatPhoto(['chat_id' => int, 'photo' => InputChatPhoto, ]) == $Updates;

$MadelineProto->messages->editChatTitle(['chat_id' => int, 'title' => string, ]) == $Updates;

$MadelineProto->messages->editInlineBotMessage(['no_webpage' => Bool, 'id' => InputBotInlineMessageID, 'message' => string, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity], ]) == $Bool;

$MadelineProto->messages->editMessage(['no_webpage' => Bool, 'peer' => InputPeer, 'id' => int, 'message' => string, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity], ]) == $Updates;

$MadelineProto->messages->exportChatInvite(['chat_id' => int, ]) == $ExportedChatInvite;

$MadelineProto->messages->forwardMessage(['peer' => InputPeer, 'id' => int, 'random_id' => long, ]) == $Updates;

$MadelineProto->messages->forwardMessages(['silent' => Bool, 'background' => Bool, 'with_my_score' => Bool, 'from_peer' => InputPeer, 'id' => [int], 'random_id' => [long], 'to_peer' => InputPeer, ]) == $Updates;

$MadelineProto->messages->getAllDrafts() == $Updates;

$MadelineProto->messages->getAllStickers(['hash' => int, ]) == $messages_AllStickers;

$MadelineProto->messages->getArchivedStickers(['masks' => Bool, 'offset_id' => long, 'limit' => int, ]) == $messages_ArchivedStickers;

$MadelineProto->messages->getAttachedStickers(['media' => InputStickeredMedia, ]) == $Vector_of_StickerSetCovered;

$MadelineProto->messages->getBotCallbackAnswer(['game' => Bool, 'peer' => InputPeer, 'msg_id' => int, 'data' => bytes, ]) == $messages_BotCallbackAnswer;

$MadelineProto->messages->getChats(['id' => [int], ]) == $messages_Chats;

$MadelineProto->messages->getDhConfig(['version' => int, 'random_length' => int, ]) == $messages_DhConfig;

$MadelineProto->messages->getDialogs(['offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, ]) == $messages_Dialogs;

$MadelineProto->messages->getDocumentByHash(['sha256' => bytes, 'size' => int, 'mime_type' => string, ]) == $Document;

$MadelineProto->messages->getFeaturedStickers(['hash' => int, ]) == $messages_FeaturedStickers;

$MadelineProto->messages->getFullChat(['chat_id' => int, ]) == $messages_ChatFull;

$MadelineProto->messages->getGameHighScores(['peer' => InputPeer, 'id' => int, 'user_id' => InputUser, ]) == $messages_HighScores;

$MadelineProto->messages->getHistory(['peer' => InputPeer, 'offset_id' => int, 'offset_date' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]) == $messages_Messages;

$MadelineProto->messages->getInlineBotResults(['bot' => InputUser, 'peer' => InputPeer, 'geo_point' => InputGeoPoint, 'query' => string, 'offset' => string, ]) == $messages_BotResults;

$MadelineProto->messages->getInlineGameHighScores(['id' => InputBotInlineMessageID, 'user_id' => InputUser, ]) == $messages_HighScores;

$MadelineProto->messages->getMaskStickers(['hash' => int, ]) == $messages_AllStickers;

$MadelineProto->messages->getMessageEditData(['peer' => InputPeer, 'id' => int, ]) == $messages_MessageEditData;

$MadelineProto->messages->getMessages(['id' => [int], ]) == $messages_Messages;

$MadelineProto->messages->getMessagesViews(['peer' => InputPeer, 'id' => [int], 'increment' => Bool, ]) == $Vector_of_int;

$MadelineProto->messages->getPeerDialogs(['peers' => [InputPeer], ]) == $messages_PeerDialogs;

$MadelineProto->messages->getPeerSettings(['peer' => InputPeer, ]) == $PeerSettings;

$MadelineProto->messages->getRecentStickers(['attached' => Bool, 'hash' => int, ]) == $messages_RecentStickers;

$MadelineProto->messages->getSavedGifs(['hash' => int, ]) == $messages_SavedGifs;

$MadelineProto->messages->getStickerSet(['stickerset' => InputStickerSet, ]) == $messages_StickerSet;

$MadelineProto->messages->getWebPagePreview(['message' => string, ]) == $MessageMedia;

$MadelineProto->messages->hideReportSpam(['peer' => InputPeer, ]) == $Bool;

$MadelineProto->messages->importChatInvite(['hash' => string, ]) == $Updates;

$MadelineProto->messages->installStickerSet(['stickerset' => InputStickerSet, 'archived' => Bool, ]) == $messages_StickerSetInstallResult;

$MadelineProto->messages->migrateChat(['chat_id' => int, ]) == $Updates;

$MadelineProto->messages->readEncryptedHistory(['peer' => InputEncryptedChat, 'max_date' => int, ]) == $Bool;

$MadelineProto->messages->readFeaturedStickers(['id' => [long], ]) == $Bool;

$MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, ]) == $messages_AffectedMessages;

$MadelineProto->messages->readMessageContents(['id' => [int], ]) == $messages_AffectedMessages;

$MadelineProto->messages->receivedMessages(['max_id' => int, ]) == $Vector_of_ReceivedNotifyMessage;

$MadelineProto->messages->receivedQueue(['max_qts' => int, ]) == $Vector_of_long;

$MadelineProto->messages->reorderStickerSets(['masks' => Bool, 'order' => [long], ]) == $Bool;

$MadelineProto->messages->reportSpam(['peer' => InputPeer, ]) == $Bool;

$MadelineProto->messages->requestEncryption(['user_id' => InputUser, 'random_id' => int, 'g_a' => bytes, ]) == $EncryptedChat;

$MadelineProto->messages->saveDraft(['no_webpage' => Bool, 'reply_to_msg_id' => int, 'peer' => InputPeer, 'message' => string, 'entities' => [MessageEntity], ]) == $Bool;

$MadelineProto->messages->saveGif(['id' => InputDocument, 'unsave' => Bool, ]) == $Bool;

$MadelineProto->messages->saveRecentSticker(['attached' => Bool, 'id' => InputDocument, 'unsave' => Bool, ]) == $Bool;

$MadelineProto->messages->search(['peer' => InputPeer, 'q' => string, 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset' => int, 'max_id' => int, 'limit' => int, ]) == $messages_Messages;

$MadelineProto->messages->searchGifs(['q' => string, 'offset' => int, ]) == $messages_FoundGifs;

$MadelineProto->messages->searchGlobal(['q' => string, 'offset_date' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]) == $messages_Messages;

$MadelineProto->messages->sendEncrypted(['peer' => InputEncryptedChat, 'random_id' => long, 'data' => bytes, ]) == $messages_SentEncryptedMessage;

$MadelineProto->messages->sendEncryptedFile(['peer' => InputEncryptedChat, 'random_id' => long, 'data' => bytes, 'file' => InputEncryptedFile, ]) == $messages_SentEncryptedMessage;

$MadelineProto->messages->sendEncryptedService(['peer' => InputEncryptedChat, 'random_id' => long, 'data' => bytes, ]) == $messages_SentEncryptedMessage;

$MadelineProto->messages->sendInlineBotResult(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'random_id' => long, 'query_id' => long, 'id' => string, ]) == $Updates;

$MadelineProto->messages->sendMedia(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'media' => InputMedia, 'random_id' => long, 'reply_markup' => ReplyMarkup, ]) == $Updates;

$MadelineProto->messages->sendMessage(['no_webpage' => Bool, 'silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'message' => string, 'random_id' => long, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity], ]) == $Updates;

$MadelineProto->messages->setBotCallbackAnswer(['alert' => Bool, 'query_id' => long, 'message' => string, 'url' => string, ]) == $Bool;

$MadelineProto->messages->setEncryptedTyping(['peer' => InputEncryptedChat, 'typing' => Bool, ]) == $Bool;

$MadelineProto->messages->setGameScore(['edit_message' => Bool, 'peer' => InputPeer, 'id' => int, 'user_id' => InputUser, 'score' => int, ]) == $Updates;

$MadelineProto->messages->setInlineBotResults(['gallery' => Bool, 'private' => Bool, 'query_id' => long, 'results' => [InputBotInlineResult], 'cache_time' => int, 'next_offset' => string, 'switch_pm' => InlineBotSwitchPM, ]) == $Bool;

$MadelineProto->messages->setInlineGameScore(['edit_message' => Bool, 'id' => InputBotInlineMessageID, 'user_id' => InputUser, 'score' => int, ]) == $Bool;

$MadelineProto->messages->setTyping(['peer' => InputPeer, 'action' => SendMessageAction, ]) == $Bool;

$MadelineProto->messages->startBot(['bot' => InputUser, 'peer' => InputPeer, 'random_id' => long, 'start_param' => string, ]) == $Updates;

$MadelineProto->messages->toggleChatAdmins(['chat_id' => int, 'enabled' => Bool, ]) == $Updates;

$MadelineProto->messages->uninstallStickerSet(['stickerset' => InputStickerSet, ]) == $Bool;

$MadelineProto->photos->deletePhotos(['id' => [InputPhoto], ]) == $Vector_of_long;

$MadelineProto->photos->getUserPhotos(['user_id' => InputUser, 'offset' => int, 'max_id' => long, 'limit' => int, ]) == $photos_Photos;

$MadelineProto->photos->updateProfilePhoto(['id' => InputPhoto, ]) == $UserProfilePhoto;

$MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, ]) == $photos_Photo;

$MadelineProto->updates->getChannelDifference(['channel' => InputChannel, 'filter' => ChannelMessagesFilter, 'pts' => int, 'limit' => int, ]) == $updates_ChannelDifference;

$MadelineProto->updates->getDifference(['pts' => int, 'date' => int, 'qts' => int, ]) == $updates_Difference;

$MadelineProto->updates->getState() == $updates_State;

$MadelineProto->upload->getFile(['location' => InputFileLocation, 'offset' => int, 'limit' => int, ]) == $upload_File;

$MadelineProto->upload->saveBigFilePart(['file_id' => long, 'file_part' => int, 'file_total_parts' => int, 'bytes' => bytes, ]) == $Bool;

$MadelineProto->upload->saveFilePart(['file_id' => long, 'file_part' => int, 'bytes' => bytes, ]) == $Bool;

$MadelineProto->users->getFullUser(['id' => InputUser, ]) == $UserFull;

$MadelineProto->users->getUsers(['id' => [InputUser], ]) == $Vector_of_User;