MadelineProto/old_docs/API_docs_v45/methods/README.md

39 KiB

title description
Methods List of methods

Methods

Back to API documentation index




$MadelineProto->account_changePhone(['phone_number' => string, 'phone_code_hash' => string, 'phone_code' => string, ]) == $User

$MadelineProto->account_checkUsername(['username' => 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, 'device_model' => string, 'system_version' => string, 'app_version' => string, 'app_sandbox' => Bool, 'lang_code' => string, ]) == $Bool

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

$MadelineProto->account_resetAuthorization(['hash' => long, ]) == $Bool

$MadelineProto->account_resetNotifySettings([]) == $Bool

$MadelineProto->account_sendChangePhoneCode(['phone_number' => string, ]) == $account_SentChangePhoneCode

$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, ]) == $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_checkPassword(['password_hash' => bytes, ]) == $auth_Authorization

$MadelineProto->auth_checkPhone(['phone_number' => string, ]) == $auth_CheckedPhone

$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_resetAuthorizations([]) == $Bool

$MadelineProto->auth_sendCall(['phone_number' => string, 'phone_code_hash' => string, ]) == $Bool

$MadelineProto->auth_sendCode(['phone_number' => string, 'sms_type' => int, 'api_id' => int, 'api_hash' => string, 'lang_code' => string, ]) == $auth_SentCode

$MadelineProto->auth_sendInvites(['phone_numbers' => [string], 'message' => string, ]) == $Bool

$MadelineProto->auth_sendSms(['phone_number' => string, 'phone_code_hash' => 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_getChannels(['id' => [InputChannel], ]) == $messages_Chats

$MadelineProto->channels_getDialogs(['offset' => int, 'limit' => int, ]) == $messages_Dialogs

$MadelineProto->channels_getFullChannel(['channel' => InputChannel, ]) == $messages_ChatFull

$MadelineProto->channels_getImportantHistory(['channel' => InputChannel, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]) == $messages_Messages

$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_toggleComments(['channel' => InputChannel, 'enabled' => Bool, ]) == $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_getSuggested(['limit' => int, ]) == $contacts_Suggested

$MadelineProto->contacts_importCard(['export_card' => [int], ]) == $User

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

$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(['device_model' => string, 'system_version' => string, 'app_version' => string, 'lang_code' => string, ]) == $help_AppChangelog

$MadelineProto->help_getAppUpdate(['device_model' => string, 'system_version' => string, 'app_version' => string, 'lang_code' => string, ]) == $help_AppUpdate

$MadelineProto->help_getConfig([]) == $Config

$MadelineProto->help_getInviteText(['lang_code' => string, ]) == $help_InviteText

$MadelineProto->help_getNearestDc([]) == $NearestDc

$MadelineProto->help_getSupport([]) == $help_Support

$MadelineProto->help_getTermsOfService(['lang_code' => string, ]) == $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_createChat(['users' => [InputUser], 'title' => string, ]) == $Updates

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

$MadelineProto->messages_deleteHistory(['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_exportChatInvite(['chat_id' => int, ]) == $ExportedChatInvite

$MadelineProto->messages_forwardMessage(['peer' => InputPeer, 'id' => int, ]) == $Updates

$MadelineProto->messages_forwardMessages(['broadcast' => Bool, 'from_peer' => InputPeer, 'id' => [int], 'to_peer' => InputPeer, ]) == $Updates

$MadelineProto->messages_getAllStickers(['hash' => int, ]) == $messages_AllStickers

$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_getFullChat(['chat_id' => int, ]) == $messages_ChatFull

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

$MadelineProto->messages_getInlineBotResults(['bot' => InputUser, 'query' => string, 'offset' => string, ]) == $messages_BotResults

$MadelineProto->messages_getMessages(['id' => [int], ]) == $messages_Messages

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

$MadelineProto->messages_getSavedGifs(['hash' => int, ]) == $messages_SavedGifs

$MadelineProto->messages_getStickerSet(['stickerset' => InputStickerSet, ]) == $messages_StickerSet

$MadelineProto->messages_getStickers(['emoticon' => string, 'hash' => string, ]) == $messages_Stickers

$MadelineProto->messages_getWebPagePreview(['message' => string, ]) == $MessageMedia

$MadelineProto->messages_importChatInvite(['hash' => string, ]) == $Updates

$MadelineProto->messages_installStickerSet(['stickerset' => InputStickerSet, 'disabled' => Bool, ]) == $Bool

$MadelineProto->messages_migrateChat(['chat_id' => int, ]) == $Updates

$MadelineProto->messages_readEncryptedHistory(['peer' => InputEncryptedChat, 'max_date' => int, ]) == $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(['order' => [long], ]) == $Bool

$MadelineProto->messages_reportSpam(['peer' => InputPeer, ]) == $Bool

$MadelineProto->messages_requestEncryption(['user_id' => InputUser, 'g_a' => bytes, ]) == $EncryptedChat

$MadelineProto->messages_saveGif(['id' => InputDocument, 'unsave' => Bool, ]) == $Bool

$MadelineProto->messages_search(['important_only' => Bool, '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_sendBroadcast(['contacts' => [InputUser], 'message' => string, 'media' => InputMedia, ]) == $Updates

$MadelineProto->messages_sendEncrypted(['peer' => InputEncryptedChat, 'data' => bytes, ]) == $messages_SentEncryptedMessage

$MadelineProto->messages_sendEncryptedFile(['peer' => InputEncryptedChat, 'data' => bytes, 'file' => InputEncryptedFile, ]) == $messages_SentEncryptedMessage

$MadelineProto->messages_sendEncryptedService(['peer' => InputEncryptedChat, 'data' => bytes, ]) == $messages_SentEncryptedMessage

$MadelineProto->messages_sendInlineBotResult(['broadcast' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'query_id' => long, 'id' => string, ]) == $Updates

$MadelineProto->messages_sendMedia(['broadcast' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'media' => InputMedia, 'reply_markup' => ReplyMarkup, ]) == $Updates

$MadelineProto->messages_sendMessage(['no_webpage' => Bool, 'broadcast' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'message' => string, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity], ]) == $Updates

$MadelineProto->messages_setEncryptedTyping(['peer' => InputEncryptedChat, 'typing' => Bool, ]) == $Bool

$MadelineProto->messages_setInlineBotResults(['gallery' => Bool, 'private' => Bool, 'query_id' => long, 'results' => [InputBotInlineResult], 'cache_time' => int, 'next_offset' => string, ]) == $Bool

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

$MadelineProto->messages_startBot(['bot' => InputUser, 'peer' => InputPeer, '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, 'crop' => InputPhotoCrop, ]) == $UserProfilePhoto

$MadelineProto->photos_uploadProfilePhoto(['file' => InputFile, 'caption' => string, 'geo_point' => InputGeoPoint, 'crop' => InputPhotoCrop, ]) == $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